Skip to main content

Global flags

These flags work with any command:
FlagDescription
-p, --prodTarget production instead of sandbox
-l, --localUse localhost:8080 API server
--headlessForce non-interactive mode (for CI/agents)
-c, --config <path>Path to config file (default: autumn.config.ts)
-v, --versionShow 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.
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]
FlagDescription
-y, --yesAuto-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]
FlagDescription
-f, --forceOverwrite 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]
FlagDescription
--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
FlagDescription
--dangerously-skip-all-confirmation-promptsSkip 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]
FlagDescription
--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]
FlagDescription
--id <id>Get a specific plan
--search <query>Filter plans
--include-archivedInclude 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]
FlagDescription
--id <id>Get a specific feature
--search <query>Filter features
--include-archivedInclude 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]
FlagDescription
--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 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

CodeMeaning
0Success
1Error (network, auth, validation, or confirmation required)