AxiomCore
Getting Started

Installation

Install the Axiom CLI and required extractor plugins.

The Axiom CLI is a unified binary written in Rust. It manages project initialization, contract compilation, diffing, testing, and cloud synchronization.

1. Install the CLI

Both macOS and Linux are supported natively. Windows users should use WSL2.

curl -fsSL https://axiomcore.dev/install | sh

Note: This script places the binary in /usr/local/bin and may require your sudo password.

brew install AxiomCore/tap/axiom

Verify the installation:

axiom --version
axiom doctor

axiom doctor is safe in any directory: it does not write files, log in, pull contracts, or expose credentials. Use axiom doctor --json --strict in CI or when attaching a machine-readable support report.

2. Join the Private Alpha

AxiomCore requires an authorized machine ID to interact with the build and release pipelines.

axiom join you@yourcompany.com

We will email you a referral code. Once received, any subsequent command will prompt you to enter it, authenticating your machine permanently.

3. Install backend extractors

Axiom uses separately installed extractors for supported backend frameworks. Each extractor has its own execution boundary. The current FastAPI path imports the selected application module, so install its required Python dependencies and keep module initialization safe for a build environment.

Depending on your backend language, install the required extractor plugin. Axiom will automatically download the correct binary for your OS and Architecture (e.g., macos-arm64) into ~/.axiom/plugins/.

axiom install axiom-fastapi --module
axiom install axiom-go-extractor --module

The axiom install command keeps extractor distribution separate from the main CLI. It does not make backend source static or side-effect free. Read the backend extraction boundary before using an extractor in CI.

4. Start with an explicit plan

From your application repository:

axiom onboard

The command detects a backend, frontend, or full-stack repository and prints the shortest supported path. It makes no changes by default. For a detected FastAPI or Go backend, add --apply to create axiom.acore; it never logs in or uploads a release on your behalf.

Support and availability

Current implementation boundaries by language, framework, artifact, and target.

Backend quickstart

Extract an existing service and compile a first reviewable contract.

On this page

1. Install the CLI2. Join the Private Alpha3. Install backend extractors4. Start with an explicit plan