CLI Overview
The atmos command-line interface.
The atmos command manages the local Atmos runtime, registers remote computers, and gives agents controlled access to app surfaces such as Canvas and Review.
Most people use Desktop or the browser app day to day. Use the CLI when you are setting up a machine, checking runtime health, registering an Atmos Computer, scripting a workflow, or giving a terminal agent a stable way to update Atmos state.
Commands
| Command | Use it for |
|---|---|
atmos runtime | Start, stop, or check the local Atmos Server |
atmos computer | Register this machine as an Atmos Computer and keep it available remotely |
atmos canvas | Let an agent read or update the open Canvas board |
atmos review | Let an agent read or update review sessions, comments, and review runs |
atmos update | Check for and install CLI updates |
Global options
| Option | Use it for |
|---|---|
--api-url <url> | Target a specific Atmos Server |
--api-token <token> | Authenticate to a protected local or remote API |
--timeout-ms <ms> | Change request timeout; default is 45000 |
--json | Print machine-readable output for scripts and agents |
Connection resolution
The CLI chooses an API URL in this order:
--api-urlATMOS_API_URL- active
~/.atmos/client-session.json ~/.atmos/runtime_manifest.json
It chooses a token in this order:
--api-tokenATMOS_API_TOKENATMOS_LOCAL_TOKEN- active client-session gateway token
When the UI is connected to a remote Atmos Computer, client-session.json lets local CLI commands target that same remote computer. Without an active session, the CLI falls back to the local runtime manifest.
Run atmos --help for the exact command list installed on your machine.