OSS / Operations
Aurora CLI
Reference for the aurora command: init, models sync|diff|show, update, uninstall, and the runtime flags.
Browse docs
The aurora command-line tool is installed with npm install -g iaurora (or npx -y iaurora). It bootstraps a local gateway instance and operates on the bundled model registry.
aurora init
Scaffold a working directory with a starter config.yaml, an .env file, and an empty data/ directory. Run this once per host.
mkdir my-gateway && cd my-gateway
aurora initWhat gets created:
config.yaml— every config section documented inline, with safe defaults.env— every env var with its default; secrets are empty placeholdersdata/— SQLite database location, model registry snapshot, user pricing overrides
You can re-run aurora init; existing files are left in place.
aurora (no args)
Start the gateway with the current working directory's config.yaml and .env.
auroraUseful flags:
-config <path>— override the config file path (equivalent toAURORA_CONFIG_PATH)-port <port>— overridePORT(default8080)-env <path>— override the.envfile path
aurora models sync
Download the upstream Aurora model registry to data/models.local.json. Use this when you want the latest model list and pricing before restart.
aurora models syncThe registry source is configurable via MODEL_LIST_URL (default: the Aurora GitHub raw URL).
aurora models diff
Compare the locally cached registry with the upstream. Useful for CI checks that fail when new model prices change your cost baseline.
aurora models diffOutput is line-oriented and grep-friendly.
aurora models show
Print the effective pricing for a model after merging all overrides and config profiles.
aurora models show gpt-4o
aurora models show anthropic/claude-sonnet-4-5Useful for debugging "why is this model priced at $X in the dashboard" questions.
aurora update
Self-update via npm install -g iaurora@latest. Requires the binary was originally installed with npm.
aurora updateIf you installed via Docker, pull the new image instead:
docker pull aurorahq/aurora:latestaurora uninstall
Remove the npm-managed binary.
aurora uninstallThis does not delete your data/ directory, config.yaml, or .env. Move those aside if you want a clean reinstall.
aurora -version
Print the gateway version and the build's edition tag.
aurora -versionaurora -help
Print the full CLI surface, including all flags, env vars, and config sections.
aurora -helpaurora -help-json
Dump the entire env-var schema as JSON. Useful for documentation generators and config-validation tools.
aurora -help-json | jq '.sections[] | {name, env_vars: (.env_vars | keys)}'Exit codes
Related
- Configuration — full env-var reference
- Config YAML —
config.yamlschema - Quick Start —
aurora initis the second step