CLI reference
Apothem CLI reference — per-command synopsis, options, and exit codes for the apothem command-line interface.
The apothem command-line interface manages harness adapter configurations
from the shared profile. Each page below documents one subcommand: its
synopsis, options, behavior, and exit codes.
Each of install, update, and uninstall also accepts a continuous-form
alias (installing, updating, uninstalling) that is identical in flags and
behavior to the base command. Updating and uninstalling through the install
channels — the Claude Code plugin, npx, and the one-shot installer
scripts — are documented in the Updating and
Uninstalling install guides, not by the aliases
themselves.
Commands
| Command | Description |
|---|---|
| quickstart | Guided first run: ensure a profile, preview the writes, then install. |
| install | Install a harness adapter configuration from the shared profile (alias: installing). |
| update | Re-install a harness adapter configuration from the current shared profile (alias: updating). |
| uninstall | Remove a harness adapter configuration (alias: uninstalling). |
| rollback | Restore a harness to the state before its recorded install. |
| verify | Verify a harness adapter installation. |
| status | Report install, verify, and drift state for every registered harness. |
| diff | Preview the pending configuration changes for a single harness. |
| harnesses | List and inspect registered harness adapters. |
| profile | Manage the shared Apothem profile. |
| migrate-workspace | Migrate a legacy per-harness workspace into the shared .apothem layout. |
| doctor | Run system diagnostics for the Apothem installation. |
| completion | Emit a sourceable shell-completion script (bash, zsh, fish, powershell). |
For slash commands and the higher-level CLI overview, see the CLI overview and Slash commands reference pages.
Plans Discipline — Project-Local Ephemeral Working Memory
Manage project-local ephemeral working memory in .apothem/plans/ (a legacy .plans/ tree is upgraded via apothem migrate-workspace) using a frontmatter schema, lifecycle transitions, promotion to ADRs, and enforcement through hooks and validators.
quickstart
CLI reference for the apothem quickstart guided first-run command.