Command reference

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

Authenticate with Autumn via OAuth. Opens your browser, lets you select an organization, and saves sandbox + production API keys to .env.

atmn login

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 logout

`atmn env`

Show your current organization and environment:

atmn env

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 init

`atmn push`

Push your local autumn.config.ts to Autumn.

atmn push [options]

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.

atmn pull [options]

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.

atmn preview [options]

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.

atmn nuke

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`

atmn customers [options]

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`

atmn plans [options]

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`

atmn features [options]

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`

atmn events [options]

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`)

Configuration

`atmn config`

View and manage persistent CLI settings.

atmn config                                    # Show help and config file location
atmn config --global                           # Same as above
atmn config --global <key>                     # Read a setting
atmn config --global <key> <value>             # Write a setting

Running atmn config with no arguments shows the full path to your config file, supported keys, and usage info.

Flag	Description
`-g, --global`	Use global config

Available keys

Key	Type	Default	Description
`noDeclarationFile`	`boolean`	`false`	Skip generating `@useautumn-sdk.d.ts` on `atmn pull`

Priority order

Settings are resolved in this order: CLI flag → global config → default value. For example, --no-declaration-file on atmn pull always takes priority over the global noDeclarationFile setting.

Config file location

Running atmn config or atmn config --global (with no key) prints the exact path to your config file on disk.

OS	Path
macOS	`~/Library/Preferences/atmn/config.json`
Linux	`~/.config/atmn/config.json` (or `$XDG_CONFIG_HOME`)
Windows	`%APPDATA%\atmn\config.json`

Utilities

`atmn dashboard`

Open the Autumn dashboard in your browser.

atmn dashboard

`atmn version`

Print the CLI version. Alias: atmn v.

atmn version

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)

​Global flags

​Authentication

​atmn login

​atmn logout

​atmn env

​Configuration

​atmn init

​atmn push

​atmn pull

​atmn preview

​atmn nuke

​Data browsing

​atmn customers

​atmn plans

​atmn features

​atmn events

​Configuration

​atmn config

​Available keys

​Priority order

​Config file location

​Utilities

​atmn dashboard

​atmn version

​Headless mode

​Exit codes

Global flags

Authentication

`atmn login`

`atmn logout`

`atmn env`

Configuration

`atmn init`

`atmn push`

`atmn pull`

`atmn preview`

`atmn nuke`

Data browsing

`atmn customers`

`atmn plans`

`atmn features`

`atmn events`

Configuration

`atmn config`

Available keys

Priority order

Config file location

Utilities

`atmn dashboard`

`atmn version`

Headless mode

Exit codes