Installation

Install Axiomatic

Install Axiomatic globally or run it directly with npx:

# Install globally
npm install -g @exalto/axiomatic

# Or run directly
npx @exalto/axiomatic

Verify the installation:

axm --version

Set Your API Key

Axiomatic uses an LLM to analyze your code. Set your provider API key:

# Anthropic (default, recommended)
export ANTHROPIC_API_KEY=sk-ant-...

# Or OpenAI
export OPENAI_API_KEY=sk-...

You can also reference environment variables in your axiomatic.yml config using ${VAR_NAME} syntax:

# axiomatic.yml
api_key: ${ANTHROPIC_API_KEY}

Initialize Your Project

Run axm init in your project root. Axiomatic detects your project type and creates an axiomatic.yml config file and an axiomatic/ directory with an example test.

axm init

This creates:

axiomatic.yml              # Provider settings, model config
axiomatic/
  no-console-log.yml  # Example test to get you started

Validate Your Setup

If something seems off, run the built-in diagnostics:

axm doctor

This checks your axiomatic.yml config, axiomatic/ directory, API key, and test files.

You can also lint your test files without running them:

axm validate

Cost Expectations

Caching means you only pay when the relevant code actually changes. A typical project with 10 tests costs a few cents per CI run after the initial analysis.

Next Steps

• Write your first test -- create and run a test in under five minutes
• Quickstart -- end-to-end walkthrough of the full workflow