Quickstart

5-Minute Quickstart

This guide walks you through the complete Axiomatic workflow from installation to running tests in CI.

1. Install

npm install -g @exalto/axiomatic

2. Set Your API Key

export ANTHROPIC_API_KEY=sk-ant-...

3. Initialize

axm init

This creates an axiomatic.yml config file and an axiomatic/ directory with an example test.

4. Run the Example Test

axm run

5. Add a Real Test

axm add "Every API route that performs a mutation must verify the user session"

The LLM agent explores your codebase and generates a focused test definition based on your description. Alternatively, use axm add --interactive for a step-by-step prompt.

6. Run With Verbose Output

axm run --verbose

Watch the agent explore your codebase, check for authentication patterns, and render a verdict.

7. Add to CI

Add this to your GitHub Actions workflow:

# .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 }}

What's Next

• Writing tests -- learn to write effective conditions
• Configuration -- customize providers, models, and caching
• CI/CD integration -- detailed setup for GitHub Actions, GitLab CI, CircleCI, and Jenkins