CLI overview

The Axiom CLI (axiom) is the single command-line tool for AxiomCore. It checks and builds Acore contracts, runs backends, frontends and databases locally, inspects applications, manages extensions and packages, and publishes releases to Axiom Cloud. This reference covers the released CLI 0.149.1: 38 top-level commands and 203 commands in total.

Diagram source

flowchart TD
  A[axiom] --> P[Setup and project]
  A --> B[Build and run]
  A --> T[Test and mock]
  A --> S[axiom server]
  A --> D[axiom database]
  A --> U[axiom ui]
  A --> C[Contracts, packages, security]
  A --> E[axiom extensions]
  A --> I[axiom inspect]

Most work happens offline on your machine. Setup commands prepare a repository and an account. Build and run commands turn Acore source into contracts and running services. The large namespaces (server, database, ui, extensions, inspect) each have their own page. Only a few commands reach Axiom Cloud; see Cloud access and telemetry.

Command pages

All top-level commands

For the separate Experimental axiom secrets source-preview namespace, use the Secrets CLI reference. Published CLI 0.149.0 does not carry its protected runtime qualification. The Cloud Dashboard workflow is deployed as Alpha.

Global options

axiom

The root command. It only dispatches to a subcommand.

axiom <COMMAND>

axiom help [COMMAND]... prints the same help as --help, for example axiom help database migrate. There are no other global options: each command takes its own options after its name. A few commands with long help, such as axiom ui inspect, print a summary with -h and the full text with --help.

axiom --version

axiom 0.149.1

Exit codes

A few commands report findings but still exit 0 by design, for example axiom diff and security check in audit mode. Use the gate the command offers, such as inspect diff --fail-on or security check --fail-on-warning. A non-zero exit is the command's result, not a guarantee that no remote state was written before a later stage failed.

Environment variables

serve, run and server run also read the provider values that your deployment files name, such as AXIOM_REDIS_URL or AXIOM_JWT_PUBLIC_KEY. See axiom server.

Cloud access and telemetry

Commands that use Axiom Cloud need network access. Most also need axiom login and, for project operations, membership in the project.

One-time access check. Axiom Cloud is in private alpha. The first time you run a command that is not on the local list (for example login, project, release, pull of a remote contract, cache, or install NAME --module), the CLI asks once for a referral code, or reads AXIOM_REFERRAL_CODE, and registers the machine. Without a code, use axiom join to join the waitlist. Local commands never ask.

Telemetry. After a command that passed the access check, the CLI sends one usage record: a random machine ID, the command name, duration, success, an error category, the OS and the CLI version. It never sends arguments, file paths, URLs, credentials or contract and project names. Set AXIOM_TELEMETRY=0 to turn it off; only 0, false, FALSE, off and OFF are recognized. Local commands send nothing.

Files and directories

A project root is the nearest directory with an AxiomDeps.toml. Do not edit .axiom/ by hand; commit the source files and the locks your workflow reviews.

Terminal interfaces

Some commands draw a keyboard interface when attached to a terminal. In CI, use their headless or JSON alternatives.

The contract inspector needs a terminal: without one it fails. For scripts, use axiom inspect overview or another axiom inspect subcommand with --format json. Its search field is not part of the keyboard contract. For a whole application, use the browser-based axiom inspect serve dashboard, which binds to loopback with a per-session token.

Automation rules

• Use --json or --format json only where a command offers it, and do not parse human or styled output.
• Use non-interactive options (--non-interactive, --project, --version, --project-id) and pinned inputs and locks in CI.
• Gate on the exit code, then read the machine output.
• Keep the private files that commands write (plans, deployments, keys, development credentials) out of source control.