description: "apothem CLI reference — all subcommands and flags."¶
CLI reference¶
The apothem CLI is the primary operator interface for managing the shared
profile and harness adapters.
Global flags¶
| Flag | Description |
|---|---|
--version |
Print the apothem version and exit |
--help |
Print help for the command |
Subcommands¶
apothem install¶
Install a harness adapter from the shared profile.
apothem install --harness <name> [--profile PATH] [--dry-run]
| Option | Description |
|---|---|
--harness <name> |
Harness adapter name (e.g. claude-code, cursor, gemini-cli). Required. |
--profile PATH |
Path to shared profile YAML. Defaults to ~/.config/apothem/profile.yaml. |
--dry-run |
Preview install without writing files. |
Install runs against one harness per invocation. To install several adapters, run the command once per harness.
apothem update¶
Re-derive a harness adapter's native config from the current shared profile.
apothem update --harness <name> [--profile PATH] [--dry-run]
| Option | Description |
|---|---|
--harness <name> |
Harness adapter name. Required. |
--profile PATH |
Path to shared profile YAML. |
--dry-run |
Preview update without writing files. |
apothem uninstall¶
Remove a harness adapter's native config.
apothem uninstall --harness <name> [--yes]
| Option | Description |
|---|---|
--harness <name> |
Harness adapter name. Required. |
--yes |
Skip the confirmation prompt. |
apothem verify¶
Verify that a harness adapter is installed and its output path is present.
apothem verify --harness <name>
| Option | Description |
|---|---|
--harness <name> |
Harness adapter name. Required. |
Exit code is 0 when the adapter is installed, 1 when it is not.
apothem profile¶
Manage the shared Apothem profile.
apothem profile show [--profile PATH]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]
| Subcommand | Description |
|---|---|
profile show |
Print the resolved profile (YAML) to stdout. |
profile set <key> <value> |
Set a profile field. The value is YAML-parsed (strings, numbers, booleans, lists, and mappings are all accepted). |
profile edit |
Open the profile in $EDITOR (falls back to the platform default). |
The --profile PATH option points each subcommand at an alternate profile
file. Defaults to ~/.config/apothem/profile.yaml.
apothem harnesses¶
List and inspect registered harness adapters.
apothem harnesses list
apothem harnesses show <name>
| Subcommand | Description |
|---|---|
harnesses list |
Print a table of every registered adapter with its installed-status flag and output path. |
harnesses show <name> |
Print name, installed state, and output path for one adapter. |
apothem doctor¶
Run system diagnostics for the Apothem installation.
apothem doctor
Prints the apothem version, Python interpreter, platform, resolved profile
path, and a per-harness install-status table. Exit code is 0 when every
registered adapter reports installed; 1 otherwise.