AtoZAPI CLI Reference
The AtoZAPI CLI scans active codebases, extracts endpoint declarations and schema constraints, compiles openapi.json specifications, and serves the embedded Swagger UI and ReDoc interfaces.
---
Global Syntax
atozapi [command] [options]If no command is provided, the CLI defaults to serve.
---
Commands
serve (default)
Scans the active directory, compiles openapi.json, and starts the localized documentation HTTP server.
atozapi serve [options]generate
Scans the codebase, compiles openapi.json to disk, and exits without launching the HTTP server. Useful for CI/CD pipelines.
atozapi generate [options]---
Command Options
| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--port | -p | Number | 8000 | Port for the documentation HTTP server. |
--dir | -d | Path | . | Target directory to recursively scan for route handlers. |
--out | -o | Path | ./openapi.json | Destination path for the compiled OpenAPI 3.0 specification. |
---
Examples
Custom Port and Scan Directory
atozapi serve --port 3001 --dir ./srcHeadless CI Specification Generation
atozapi generate --out ./public/openapi.json---
Standalone Native Binaries (Zero-Node)
For Go and PHP/Laravel projects that do not have Node.js installed in their development or CI environment, precompiled single-file binaries are available from GitHub Releases:
Linux (x64)
curl -LO https://github.com/dhirajparihar/AtoZAPI/releases/latest/download/atozapi-linux-x64
chmod +x atozapi-linux-x64
./atozapi-linux-x64 serve --port 8000macOS (x64 / Apple Silicon via Rosetta)
curl -LO https://github.com/dhirajparihar/AtoZAPI/releases/latest/download/atozapi-macos-x64
chmod +x atozapi-macos-x64
./atozapi-macos-x64 serve --port 8000Windows (x64)
# In PowerShell:
Invoke-WebRequest -Uri "https://github.com/dhirajparihar/AtoZAPI/releases/latest/download/atozapi-win-x64.exe" -OutFile "atozapi.exe"
.\atozapi.exe serve---
Scanner Discovery Rules & Best Practices
AtoZAPI scans your workspace statically using high-speed AST and pattern parsing. To ensure 100% accurate route discovery and OpenAPI contract compilation, follow these best practices:
1. Framework Signatures
The scanner detects endpoints matching these patterns: - Express:app.(post|get|put|delete|patch)(path, atozapi(schema)) or router.(post|get|put|delete|patch)(...)
- Next.js App Router: export const (POST|GET|PUT|DELETE|PATCH) = nextAtozapi({ schema, handler }) in app//route.(js|ts)
- Go (Gin): r.(POST|GET|PUT|DELETE|PATCH)(path, ginatozapi.Guard(Struct{}))
- Laravel: Controller action methods decorated with #[Post(path: '...', rules: [...])]
2. Schema Declaration Proximity
For JavaScript and TypeScript projects: - Recommended: Declare schema variables (const mySchema = { ... }) in the same file as the route, or inline directly within atozapi({ ... }).
- This ensures the static scanner can resolve all field constraints and types without needing a running runtime or module bundler.
3. Excluded Directories
The scanner automatically skips build and dependency directories:node_modules, .git, .next, dist, build, coverage, .turbo, tests, docs.