AutoMaxReference
CLI overview
Global options, exit codes and the full command map of the automax command.
What you'll learn
How the automax command is organised, which global options every command accepts, what the exit
codes mean, and where each command group is documented.
Invocation
Inside the repository the command runs from source:
bun run automax <command> [options]After publishing, npx automax <command> or a global install do the same.
Global options
| Option | Effect |
|---|---|
--json | machine-readable output; errors become { "error": { code, message, hint, docsUrl } } on stderr |
-q, --quiet | errors only |
--verbose | debug logging |
--cwd <dir> | repository root; by default AutoMax walks up from the current directory to find automax.workspace.yaml, automax.config.ts or a projects/ folder |
--no-color | disable colours |
-V, --version | print the version |
Every flag has an AUTOMAX_* environment equivalent, listed in Environment variables.
Exit codes
| Code | Meaning |
|---|---|
0 | success |
1 | test failures, or a runtime error |
2 | configuration or usage error (unknown project, missing environment, invalid YAML, unresolved variable) |
3 | lint errors |
130 | cancelled |
Command map
| Group | Commands | Status |
|---|---|---|
| Onboarding | init, analyze, project, env, config, doctor | project, env, config, doctor available |
| Authoring and execution | run / test / watch, lint, steps, features, coverage, browsers, processes | Phases 1–2, 12 |
| Record and playback | record / codegen, har, auth | Phases 3, 6 |
| Data and database | data, db | Phase 5 |
| Results and learning | report, show-report, trace, heal, insights | Phases 2, 5, 8 |
| Agents | agent, proposals | Phase 8 |
| Platform | mcp, serve, users, tokens, schedule, integrations, completion, upgrade | Phases 7, 9, 11 |
Run bun run automax --help or bun run automax <command> --help for the live surface.
bun run automax --help