Skip to main content

Install the AXM CLI

Install the axm command-line tool to develop and publish axioms. Using the CLI requires an early access plan.

Install the CLI

Recommended. Works on macOS, Linux, and Windows. Paste this into your AI coding agent (Claude Code, Cursor, Copilot, Codex) and it will install axm, sign you in, and set up your workspace.

Prompt for your AI agent
Set up Axiom CLI (axm) on my machine. Work through these steps in order. Stop if any step fails.

1. Install axm. If it's already on my PATH, skip to step 2. Otherwise run the command for my OS:
   - macOS / Linux: curl -sfL https://install.axiom.computer | sh -
   - Windows (PowerShell): irm https://install.axiom.computer/install.ps1 | iex
2. Authenticate: run `axm auth`. It opens a browser for me to sign in and mint a CLI token — wait for me to finish, then continue.
3. Create my workspace: run `axm init axiom-workspace` (or another NEW directory name — `axm init` aborts if the target directory isn't empty). It clones the workspace plus Axiom's AI skills and pre-warms the Lean build, which can take a minute. Then `cd` into that directory.
4. Verify: from inside the workspace, run `axm status` and show me the output so I can confirm I'm authenticated and the workspace is ready.
5. Load the agent instructions/skills into your context and tell me what I can do with my Axiom workspace

Rules: if a command errors, show me the exact output and stop — don't guess or work around it. Don't run `axm publish`.

Prefer to run the commands yourself? Use the or option.

Get started

  1. Install the CLI

    Use one of the methods above to get the axm command on your PATH.

  2. Authenticate

    Run axm auth. It opens your browser to sign in and mint a CLI token, then drops you back in the terminal.

    axm auth
  3. Set up your workspace

    Run axm init axiom-workspace (or any new directory name). It clones your workspace and Axiom's AI skills into that folder and pre-warms the Lean build. It won't write into a non-empty directory, so give it a fresh name.

    axm init axiom-workspace
  4. Develop your idea, then publish

    Describe what you want to formalize to your AI agent. With Axiom's AI skills it helps you develop the proof in Lean while you steer by prompting. When you're happy, validate with axm check, then submit with axm publish. Publishing is final, so review your work first.

    axm check
    axm publish