Quickstart

Install

curl -fsSL https://axiomatic.sh/api/install | sh

Or via npm: npm install -g @exalto/axiomatic. Verify with axm --version.

Choose Your Path

Axiomatic works two ways: with the platform (free credits, best-practice packs, dashboard, shared agent memory) or locally (standalone, no account needed, bring your own API key).

Option A: Platform (recommended)

Sign in with GitHub to get $5/month in free LLM credits — no API key required to start. You also get access to curated best-practice packs, a dashboard for tracking results, and shared agent memory that cuts costs 60-80%.

# 1. Sign in with GitHub
axm login

# 2. Install best-practice packs for your stack
axm install --suggest

# 3. Enforce your standards
axm run

axm install --suggest scans your project's dependencies (e.g. Next.js, Express, Prisma) and recommends best-practice packs — OWASP security, API design, framework-specific standards. An LLM adapts each test to your actual codebase — file paths, patterns, and conventions are all tailored automatically.

Check your credit balance anytime:

axm credits

When you're logged in, results sync to the dashboard automatically. Prompt caching and shared agent memory reduce costs 60-80% on subsequent runs. You can also bring your own API key alongside platform features — set ANTHROPIC_API_KEY and requests go direct to the provider while you keep dashboard sync and shared memory.

Option B: Local (no account needed)

Set your provider API key and go. The CLI works fully standalone — nothing leaves your machine except LLM API calls.

# 1. Set your API key
export ANTHROPIC_API_KEY=sk-ant-...   # or OPENAI_API_KEY=sk-...

# 2. Initialize your project
axm init

# 3. Run your tests
axm run

axm init uses an LLM to explore your codebase and generate 3-5 relevant starter tests automatically. You can connect to the platform later with axm login whenever you want dashboard features or team sharing.

What Just Happened

After running axm init, your project has:

axiomatic.yml              # Provider settings, model config
axiomatic/
  auth-required.yml        # Example: generated based on your codebase
  no-hardcoded-secrets.yml # Example: generated based on your codebase

Each .yml file is a test — a plain-English standard verified by an AI agent against your source code. When you ran axm run, the agent read each condition, explored the relevant files, and returned a verdict with confidence scores and specific file/line violations.

Add More Tests

Write a test in natural language:

axm add "all database queries must go through the repository layer in src/data/"

Or browse and install curated test packs:

axm install --suggest    # auto-detect your stack
axm install owasp-security   # install a specific pack

Add to CI

# .github/workflows/axiomatic.yml
name: Axiomatic

on:
  pull_request:
    branches: [main]

jobs:
  axiomatic:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm install -g @exalto/axiomatic
      - name: Run Axiomatic tests
        run: axm run --format github
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

Using platform credits in CI? Replace the ANTHROPIC_API_KEY env with AXM_TOKEN:

      - name: Run Axiomatic tests
        run: axm run --format github
        env:
          AXM_TOKEN: ${{ secrets.AXM_TOKEN }}

Next Steps

First Test — understand results, write a real test, see the before/after
Writing Tests — effective conditions, examples across security, architecture, and code quality
CI/CD Integration — GitHub Actions, GitLab CI, CircleCI, and Jenkins
Dashboard — track results, manage orgs, monitor confidence trends
Billing — plan tiers, credits, and BYO key details

Quickstart

On this page