Skip to main content

​
Atomic Documentation

Atomic is a terminal coding-agent runtime for repeatable, inspectable engineering work. Extend its small core with TypeScript extensions, skills, prompt templates, themes, workflows, subagents, MCP, web access, and Atomic packages.

​
Quick start

Install the published package globally with npm:
With pnpm:
With Bun:
Package installation requires Node.js. Atomic does not require package install scripts; add --ignore-scripts if you want to disable dependency lifecycle scripts during a package install. Alternatively, install the self-contained release archive, which needs no Node.js or package manager. On macOS or Linux:
On Windows PowerShell:
The archive installer verifies the GitHub Release checksum and installs the full payload under a versioned root. See the Quickstart for its parameters (ATOMIC_VERSION, ATOMIC_INSTALL_DIR, ATOMIC_BIN_DIR, GITHUB_TOKEN/GH_TOKEN), default paths, and PATH guidance. Then run it in a project directory:
Authenticate with /login for subscription providers, or set an API key such as ANTHROPIC_API_KEY before starting Atomic. For the full first-run flow, see Quickstart.

​
Documentation paths

Choose a documentation path based on what you want to do.
  • Learn — install Atomic, run a first session, and get good at everyday use. Start with the Quickstart if you have never run Atomic, then read the Guides.
  • Build — extend Atomic with prompt templates, skills, subagents, intercom, workflows, extensions, and packages, or embed it with programmatic use.
  • Reference — look up an exact command, flag, setting, event, method, type, or tool contract.

​
First successful session

  1. Install Atomic.
  2. Authenticate a provider.
  3. Start your first session.
  4. Add project instructions.
  5. Learn the interactive commands.
  6. Learn sessions and context management.