CLI reference

Diagnose and begin

doctor does not log in, pull a contract, or edit the workspace. Prefer its JSON form in CI and support reports:

axiom doctor --json --strict

Evaluate, validate, and build

benchmark defaults to 10 measured iterations, 2 warmups, and axiom-benchmark.json. Results describe that machine and checkout; use the same inputs and environment when comparing reports.

Local development

The current watcher is not a general recursive source watcher. Confirm that your extractor entrypoint is among the watched paths; use the explicit build and test commands in CI.

Pull a client

axiom pull accepts one source through the positional argument or --contract: a local .axiom, dependency config, AxiomCore URL, or organization/project[/version] reference.

axiom pull ../backend/axiom.axiom --framework atmx-web
axiom pull organization/project/1.2.0 --framework flutter --out lib/axiom
axiom pull --contract-config AxiomDeps.toml --framework atmx-react

Useful flags are --framework, --name, --out, --contract, and --contract-config. Project privacy is enforced by the service. Do not infer that an anonymous not found response proves whether a private project exists.

Contract dependency locks

These commands manage AxiomDeps.toml and the default axiom.ui.lock.json for Acore UI contract dependencies:

All accept their documented --deps or --lock overrides where applicable. Unsigned local entries produce a development warning.

Typed frontend packages

Marketplace discovery and installation are not provided by these commands. They consume explicit package files and locks.

Acore UI applications

Target values currently used by the application workflow are web, android, and ios. Native availability depends on an installed Axiom UI Host and local emulator/simulator prerequisites.

UI Host commands

axiom ui host install, status, and recover install or inspect the development host and recover stale delivery-control state. Installation can use a verified release manifest/variant or an explicit host fixture accepted by the current development workflow.

Application artifacts

axiom ui build main.acore --target web --development
axiom inspect dist/my-app-web.axiomapp
axiom install dist/my-app-web.axiomapp
axiom run dist/my-app-web.axiomapp --target web

axiom install FILE.axiomapp verifies and copies the intact artifact to the local content-addressed application cache. axiom package combines compatible target artifacts into one multi-target envelope. A production-mode build rejects unsigned local contract dependencies; --development records them in the manifest. Physical-device certification and store publishing are not part of this CLI contract today.

Cloud projects and releases

Project operations require authentication, membership, and a reachable control plane. Releasing is not the same as immediate production deployment; Cloud validation, policy, channel, and environment state determine the durable outcome.

CLI cache

axiom cache ls, axiom cache get --key KEY, and axiom cache clear inspect the CLI profile's local Sled cache. The list UI can delete the selected entry with x. These commands do not claim to clear every Flutter application or browser session cache.

Exit behavior and automation

• use --json only where the command explicitly supports it;
• use non-interactive flags and pinned inputs in CI;
• treat a non-zero exit as the command result, not a guarantee that no remote state was written before a later stage failed; and
• avoid parsing human-oriented TUI or styled output as an API.