Skip to main content
Complete reference for all atmn CLI commands with every flag, argument, and default value.

​
Global Options

These options are available for all commands:
​
-p, --prod
flag
Use production environment instead of sandbox
​
-l, --local
flag
Use localhost:8080 API server instead of api.useautumn.com
​
--headless
flag
Force non-interactive mode (useful for CI/agents)
​
-c, --config <path>
string
default:"autumn.config.ts"
Path to configuration file

​
Global Flag Combinations

FlagsEnvironmentAPI ServerUse Case
(none)SandboxRemoteDefault development
-pProductionRemoteProduction deployment
-lSandboxLocalLocal development
-lpProductionLocalLocal dev with prod data

​
Authentication Commands

​
atmn login

Authenticate with Autumn using OAuth 2.0. 
atmn login
Behavior:
  • Interactive: Beautiful OAuth flow with browser integration
  • Headless: Opens browser with fallback URL
  • Creates: API keys for both sandbox and production
  • Stores: Keys in .env file
No additional options

​
atmn logout

Remove API keys from environment file. 
atmn logout
Removes:
  • AUTUMN_SECRET_KEY (sandbox)
  • AUTUMN_PROD_SECRET_KEY (production)
No additional options

​
atmn env

Display current environment and organization info. 
atmn env
Displays:
  • Organization name and slug
  • Current environment (sandbox/production)
  • API endpoint being used
No additional options

​
Configuration Commands

​
atmn init

Initialize a new Autumn project with template selection. 
atmn init
Features:
  • Interactive: Template selection wizard
  • Headless: Uses default template
  • Templates: OpenAI, T3 Chat, Railway, Linear
  • Generates: autumn.config.ts and optional .env
No additional options

​
atmn push

Push local configuration to Autumn. 
atmn push [options]
​
-y, --yes
flag
Automatically confirm all prompts (useful for CI/CD)
Features:
  • Change analysis and smart prompts
  • Production safety guards
  • Plan versioning for customers
  • Batch operations

​
atmn pull

Pull configuration from Autumn to local files. 
atmn pull [options]
​
-f, --force
flag
Force overwrite config instead of in-place updates
Features:
  • Smart in-place updates (preserves local changes)
  • SDK type generation
  • Multi-environment merging

​
Data Commands

​
atmn customers

Browse and inspect customer data. 
atmn customers [options]
​
--headless
flag
Run in headless mode (output for scripts/agents)
​
--page <n>
number
default:"1"
Page number for pagination (headless mode)
​
--search <query>
string
Search query for filtering customers (headless mode)
​
--id <id>
string
Get specific customer by ID (headless mode)
​
--limit <n>
number
default:"50"
Number of customers per page (headless mode)
​
--format <format>
enum
default:"text"
Output format: text, json, csv (headless mode)

​
atmn plans / atmn products

Browse and inspect plans/products. Both commands are identical. 
atmn plans [options]
atmn products [options]  # Alias
​
--headless
flag
Run in headless mode (output for scripts/agents)
​
--page <n>
number
default:"1"
Page number for pagination (headless mode)
​
--search <query>
string
Search query for filtering plans (headless mode)
​
--id <id>
string
Get specific plan by ID (headless mode)
​
--limit <n>
number
default:"50"
Number of plans per page (headless mode)
​
--format <format>
enum
default:"text"
Output format: text, json, csv (headless mode)
​
--include-archived
flag
Include archived plans in results

​
atmn features

Browse and inspect feature definitions. 
atmn features [options]
​
--headless
flag
Run in headless mode (output for scripts/agents)
​
--page <n>
number
default:"1"
Page number for pagination (headless mode)
​
--search <query>
string
Search query for filtering features (headless mode)
​
--id <id>
string
Get specific feature by ID (headless mode)
​
--limit <n>
number
default:"50"
Number of features per page (headless mode)
​
--format <format>
enum
default:"text"
Output format: text, json, csv (headless mode)
​
--include-archived
flag
Include archived features in results

​
atmn events

Browse and analyze usage events. 
atmn events [options]
​
--headless
flag
Run in headless mode (output for scripts/agents)
​
--page <n>
number
default:"1"
Page number for pagination
​
--customer <id>
string
Filter events by customer ID
​
--feature <id>
string
Filter by feature ID (comma-separated for multiple)
​
--limit <n>
number
default:"100"
Number of events per page
​
--time <range>
enum
default:"7d"
Time range: 24h, 7d, 30d, 90d
​
--mode <mode>
enum
default:"list"
View mode: list (individual events) or aggregate (summary stats)
​
--bin <size>
enum
Bin size for aggregate mode: hour, day, month
​
--group-by <property>
string
Group by property for aggregate mode (e.g., customer_id, feature_id)
​
--format <format>
enum
default:"text"
Output format: text, json, csv

​
Utility Commands

​
atmn preview

Preview plans from local configuration without API calls. 
atmn preview [options]
​
--plan <id>
string
Preview specific plan by ID (shows all plans if omitted)
​
--currency <code>
string
default:"USD"
Currency code for price display
Features:
  • Renders pricing tables from autumn.config.ts
  • No API calls required
  • Useful for local development and testing

​
atmn dashboard

Open Autumn dashboard in browser. 
atmn dashboard
Opens:
  • https://app.useautumn.com (default)
  • http://localhost:3000 (with --local flag)
No additional options

​
atmn nuke

⚠️ DESTRUCTIVE: Permanently delete all sandbox data. 
atmn nuke [options]
​
--dangerously-skip-all-confirmation-prompts
flag
Skip all confirmation prompts (VERY DANGEROUS)
Safety Features:
  • Sandbox only - Refuses to run with --prod flag
  • Multiple confirmations required
  • Visual warnings with red text
  • Explicit flag name for dangerous skip option
Error with Production: 
ERROR: nuke command is only available for sandbox!
Remove the -p/--prod flag to nuke your sandbox.

​
atmn version / atmn v

Display CLI version. 
atmn version
atmn v  # Alias
Output:
  • Version from package.json (e.g., 1.0.0-beta.15)
  • "dev" in development environments
No additional options

​
Command Examples

​
Environment Management

atmn env

# Output:
# Organization: Acme Corp
# Slug: acme-corp
# Environment: Sandbox

​
Configuration Workflow

atmn login                    # Authenticate
atmn init                     # Create project
atmn push                     # Deploy to sandbox
atmn preview                  # Preview locally
atmn push --prod             # Deploy to production

​
Data Export

atmn customers --headless --format csv > customers.csv
atmn customers --headless --search "john@" --format json

​
CI/CD Usage

# Headless mode with auto-confirmation
atmn push --prod --yes --headless

# Exit codes for error handling
if atmn push --yes; then
  echo "Deployment successful"
else
  echo "Deployment failed"
  exit 1
fi

​
Exit Codes

All commands return appropriate exit codes:
​
0
exit-code
Success - Operation completed successfully
​
1
exit-code
General error - Command failed (network, auth, validation, etc.)
​
2
exit-code
Configuration error - Invalid autumn.config.ts or missing file

​
Error Handling

Common error scenarios and CLI behavior:

​
Authentication Errors

# 401 Unauthorized - triggers automatic re-auth
atmn push
# → CLI automatically runs OAuth flow
# → Retries original command

​
Configuration Errors

# Missing config file
atmn push
# Error: autumn.config.ts not found
# Run `atmn init` to create a config file

# Invalid configuration
atmn push  
# Error: Feature "invalid-id" uses unsupported characters
# IDs must be lowercase letters, numbers, and underscores only

​
Network Errors

# Connection issues - automatic retry with backoff
atmn pull
# Retrying connection... (attempt 2/3)
# ✓ Connected successfully
The CLI is designed to be resilient with clear error messages and automatic recovery where possible.