Global flags
These flags work with any command:
| Flag | Description |
|---|
-p, --prod | Target production instead of sandbox |
-l, --local | Use localhost:8080 API server |
--headless | Force non-interactive mode (for CI/agents) |
-c, --config <path> | Path to config file (default: autumn.config.ts) |
-v, --version | Show CLI version |
Flags can be combined — for example, atmn push -lp targets production on a local API server.
Authentication
atmn login
Authenticate with Autumn via OAuth. Opens your browser, lets you select an organization, and saves sandbox + production API keys to .env.
In non-TTY environments (CI), it prints a URL you can open manually.
atmn logout
Remove AUTUMN_SECRET_KEY and AUTUMN_PROD_SECRET_KEY from your .env file.
atmn env
Show your current organization and environment:
Organization: Acme Corp
Slug: acme-corp
Environment: Sandbox
Configuration
atmn init
Create an autumn.config.ts from a starter template. Prompts for login if you haven’t authenticated yet.
atmn push
Push your local autumn.config.ts to Autumn.
| Flag | Description |
|---|
-y, --yes | Auto-confirm all prompts |
The CLI compares your local config with what’s in Autumn and shows a summary of changes before applying. If plans with existing customers are modified, it will prompt about versioning.
atmn pull
Pull plans and features from Autumn into your local autumn.config.ts.
| Flag | Description |
|---|
-f, --force | Overwrite config instead of smart in-place update |
By default, pull does a smart in-place update — it adds new features and plans, updates existing ones, and removes deleted ones while preserving your formatting. Use --force to overwrite the entire file.
pull also generates an @useautumn-sdk.d.ts file with typed FeatureIds and PlanIds for IDE autocompletion.
atmn preview
Render a pricing table from your local config without making any API calls.
| Flag | Description |
|---|
--plan <id> | Preview a specific plan |
--currency <code> | Currency for display (default: USD) |
atmn nuke
Permanently delete all data in your sandbox. This command refuses to run with --prod.
| Flag | Description |
|---|
--dangerously-skip-all-confirmation-prompts | Skip all safety prompts |
This is irreversible. The flag name is intentionally long to prevent accidental use.
Data browsing
These commands open a full interactive TUI for browsing and inspecting your Autumn data. Use the --headless flag to get structured data instead.
atmn customers
| Flag | Description |
|---|
--id <id> | Get a specific customer |
--search <query> | Filter customers |
--page <n> | Page number (default: 1) |
--limit <n> | Results per page (default: 50) |
--format <fmt> | Output: text, json, csv (default: text) |
atmn plans
| Flag | Description |
|---|
--id <id> | Get a specific plan |
--search <query> | Filter plans |
--include-archived | Include archived plans |
--page <n> | Page number (default: 1) |
--limit <n> | Results per page (default: 50) |
--format <fmt> | Output: text, json, csv (default: text) |
atmn products is an alias for atmn plans.
atmn features
| Flag | Description |
|---|
--id <id> | Get a specific feature |
--search <query> | Filter features |
--include-archived | Include archived features |
--page <n> | Page number (default: 1) |
--limit <n> | Results per page (default: 50) |
--format <fmt> | Output: text, json, csv (default: text) |
atmn events
| Flag | Description |
|---|
--customer <id> | Filter by customer |
--feature <id> | Filter by feature (comma-separated for multiple) |
--time <range> | Time range: 24h, 7d, 30d, 90d (default: 7d) |
--mode <mode> | list or aggregate (default: list) |
--bin <size> | Bin size for aggregate: hour, day, month |
--group-by <prop> | Group by property in aggregate mode |
--page <n> | Page number (default: 1) |
--limit <n> | Results per page (default: 100) |
--format <fmt> | Output: text, json, csv (default: text) |
Utilities
atmn dashboard
Open the Autumn dashboard in your browser.
atmn version
Print the CLI version. Alias: atmn v.
Headless mode
The CLI automatically detects non-TTY environments and switches to headless mode with plain text output and no interactive prompts. You can also force it with --headless.
Exit codes
| Code | Meaning |
|---|
0 | Success |
1 | Error (network, auth, validation, or confirmation required) |