Skip to main content

Configuration

axag-cli works out of the box with zero configuration. For advanced use, create axag.config.json (or run axag init).

Full Configuration Reference

{
"$schema": "https://axag.dev/schema/v1/config.json",
"outputDir": ".axag",
"domain": "ecommerce",
"ai": {
"enabled": false,
"provider": "openai",
"model": "gpt-4o"
},
"scanner": {
"maxPages": 10,
"headless": true,
"timeout": 30000,
"excludePatterns": ["logout", "signout", "/admin"]
},
"validation": {
"conformanceLevel": "AA",
"strict": false
}
}

Fields

Top-Level

FieldTypeDefaultDescription
outputDirstring".axag"Directory for scan results and reports
domainstringauto-detectedDomain hint for inference: ecommerce, crm, analytics, enterprise, support, marketing, travel, jobs

ai

FieldTypeDefaultDescription
enabledbooleanfalseEnable AI-powered inference for low-confidence results
providerstring"openai"AI provider: openai or anthropic
modelstring"gpt-4o"Model to use for inference
note

When AI is enabled, set the OPENAI_API_KEY or ANTHROPIC_API_KEY environment variable.

scanner

FieldTypeDefaultDescription
maxPagesnumber10Maximum pages to crawl
headlessbooleantrueRun browser in headless mode
timeoutnumber30000Page load timeout in milliseconds
excludePatternsstring[][]URL patterns to skip during crawling

validation

FieldTypeDefaultDescription
conformanceLevelstring"AA"Target level: A, AA, or AAA
strictbooleanfalseTreat warnings as errors

Config File Locations

Configuration is loaded using cosmiconfig, which searches for:

  1. axag.config.json
  2. .axagrc
  3. .axagrc.json
  4. .axagrc.yaml
  5. "axag" key in package.json

Environment Variables

VariableDescription
OPENAI_API_KEYAPI key for OpenAI inference
ANTHROPIC_API_KEYAPI key for Anthropic inference