Skip to content

CLI Reference

Command-line interface for Archlette.

Syntax

archlette [-f <config.yaml>] [stage]

Stage defaults to all. Full pipeline.

Options

-f, --file <path> Path to configuration file. Defaults to archlette.config.yaml in current directory.

npx archlette -f archlette.config.yaml
npx archlette -f configs/production.yaml

Stages

Stages chain automatically. Each runs all previous stages.

all (default) Run full pipeline: Extract → Validate → Generate → Render → Docs

npx archlette
npx archlette -f archlette.config.yaml
npx archlette -f archlette.config.yaml all

extract Extract architecture from source code. Produces IR JSON.

npx archlette -f archlette.config.yaml extract

validate Extract + validate IR against schema.

npx archlette -f archlette.config.yaml validate

generate Extract + validate + generate DSL files.

npx archlette -f archlette.config.yaml generate

render Extract + validate + generate + render diagrams to images.

npx archlette -f archlette.config.yaml render

docs Alias for all. Full pipeline.

npx archlette -f archlette.config.yaml docs

Usage Patterns

Development:

# Test extraction
npx archlette -f archlette.config.yaml extract

# Check validation
npx archlette -f archlette.config.yaml validate

# Test DSL generation
npx archlette -f archlette.config.yaml generate

Production:

# Full pipeline
npx archlette -f archlette.config.yaml

CI/CD:

# With specific config
npx archlette -f archlette.config.yaml all

Exit Codes

  • 0 — Success
  • 1 — Error (validation failed, file not found, etc.)

Environment Variables

None currently supported.

See Also