Skip to content

docs: comprehensive atmn CLI documentation#16

Open
joejohnson123[bot] wants to merge 1 commit intomainfrom
atmn/cli-docs
Open

docs: comprehensive atmn CLI documentation#16
joejohnson123[bot] wants to merge 1 commit intomainfrom
atmn/cli-docs

Conversation

@joejohnson123
Copy link
Copy Markdown
Contributor

@joejohnson123 joejohnson123 bot commented Feb 18, 2026

Adds 10 new CLI documentation pages covering the full atmn CLI (v2.1):

  • Getting Started — install, login, init
  • Authentication — OAuth flow, API keys, env management
  • Config Reference — full autumn.config.ts reference with ParamField components (replaces old config page)
  • Push & Pull — sync workflows, change analysis, production guards
  • Data Commands — customers, plans, features, events browsing
  • Templates — built-in starter configs
  • SDK Types — TypeScript definition generation
  • CI/CD — headless mode, GitHub Actions setup
  • Command Reference — all 15 commands with flags
  • Workflows — local dev, sandbox→prod, nuke, preview

4,200+ lines of new documentation. Cross-referenced against feat/atmn-v2.1 source code.


Summary by cubic

Adds a full CLI docs set for atmn v2.1 with clear guides for setup, workflows, automation, and commands. Also organizes the CLI docs in navigation and replaces the config page with a complete autumn.config.ts reference.

  • New Documentation

    • 10 pages: Getting Started, Authentication, Config Reference, Push/Pull, Data, Templates, SDK Types, CI/CD, Command Reference, Workflows.
    • Replaces the old config page with a complete autumn.config.ts reference using ParamField components.
  • Navigation

    • Updates docs.json to include and order all CLI pages under API Reference → CLI.

Written for commit 36f2b7e. Summary will update on new commits.

- Add 9 new CLI documentation pages:
  - getting-started.mdx: Installation, auth, first project setup
  - authentication.mdx: OAuth flow, API keys, environment management
  - push-pull.mdx: Config sync workflows and change analysis
  - data.mdx: Customer, plan, feature, and event data commands
  - templates.mdx: Built-in project templates and customization
  - sdk-types.mdx: TypeScript type generation for SDK integration
  - ci-cd.mdx: Automated deployment and environment setup
  - commands.mdx: Complete command reference with all options
  - workflows.mdx: Development patterns and best practices

- Replace config.mdx with comprehensive API reference:
  - Complete feature() and plan() parameter documentation
  - All feature types: boolean, metered, credit_system
  - Plan feature configurations with pricing models
  - Examples for every billing scenario

- Update docs.json navigation:
  - Add all new CLI pages to API Reference tab
  - Organize in logical order from getting started to advanced

Key corrections applied:
- API key prefixes: am_sk_test_* (sandbox), am_sk_live_* (production)
- Feature types: boolean, metered (with consumable), credit_system
- Reference-style documentation with ParamField components
- Cross-referenced with actual CLI source code for accuracy
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 11 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants