AxiomBase CLI

Local-first document rendering for shell scripts, CI, and coding agents. Conversion runs on your machine via the embedded engine — document content never leaves your computer.

axiombase render report.md --format pdf --out report.pdf
axiombase render report.md --format pdf,docx,typst,latex --out ./dist
cat notes.md | axiombase render - --format pdf --out notes.pdf
axiombase validate report.md --template business-modern
axiombase templates list
axiombase batch "docs/**/*.md" --format pdf --out ./dist --source ci --concurrency 4 --json
axiombase license status
axiombase capabilities --json

axiombase capabilities --json prints the full machine-readable manifest — every command, flag, format, template, license tier, and exit code — so an agent can drive the CLI without reading docs.

Configuration:

export AXIOMBASE_API_KEY=axb_...   # required even for the free tier: https://axiombase.ai/keys

Rendering is local by default (pdf, docx, typst, latex). Pass --cloud for the cloud-only formats preview_png and share_link, or set AXIOMBASE_RENDER_MODE=cloud.

Exit codes:

| Code | Meaning | | --- | --- | | 0 | Success | | 1 | Render failure | | 2 | Invalid CLI usage | | 3 | Auth failure / API key missing | | 4 | Artifact download or checksum failure (cloud mode) | | 5 | Local engine unavailable (use --cloud) |

Use --json for machine-readable output in CI and agents; errors print a {"status":"failed","error":{...}} envelope to stdout as well, so stdout is always parseable. Every payload carries "schema_version": "1" — additive field additions do not bump it.

Free-tier renders carry a small footer watermark on PDF; Pro templates require a Pro key. Offline, the CLI degrades to the free tier and keeps working — check axiombase license status when in doubt.

More detail: docs/cli/axiombase-cli-quickstart.md.