Referência da CLI

A CLI apothem é a interface principal do operador para gerenciar o perfil compartilhado e os adaptadores de ferramenta.

Flags globais

Flag	Descrição
`--version`	Imprime a versão do Apothem e sai
`--help`	Imprime a ajuda do comando

Subcomandos

`apothem install`

Instala um adaptador de ferramenta a partir do perfil compartilhado.

apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]

Opção	Descrição
`--harness <name>`	Nome do adaptador de ferramenta (veja os valores canônicos abaixo). Obrigatório.
`--profile PATH`	Caminho para o YAML do perfil compartilhado. Padrão: `~/.config/apothem/profile.yaml`.
`--project PATH`	Raiz do projeto para ferramentas com escopo de projeto.
`--dry-run`	Pré-visualiza a instalação sem gravar arquivos.

Valores canônicos de --harness:

antigravity
claude-code
codebuddy
codex
cursor
gemini-cli
github-copilot
hermes
kiro
open-claw
opencode
qwen-code
trae
windsurf
zed

Use --harness all --project <path> para selecionar o conjunto de todo o registro. A lista exclude_harnesses do perfil é respeitada durante a seleção em lote de instalação/atualização.

`apothem update`

Re-deriva a configuração nativa de um adaptador de ferramenta a partir do perfil compartilhado atual.

apothem update --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]

Opção	Descrição
`--harness <name>`	Nome do adaptador de ferramenta. Obrigatório.
`--profile PATH`	Caminho para o YAML do perfil compartilhado.
`--project PATH`	Raiz do projeto para ferramentas com escopo de projeto.
`--dry-run`	Pré-visualiza a atualização sem gravar arquivos.

update rematerializa a saída da ferramenta. Ele não atualiza o pacote da CLI do Apothem; para atualizações de pacote, use o gerenciador de pacotes com o qual o Apothem foi instalado.

`apothem uninstall`

Remove a configuração nativa de um adaptador de ferramenta.

apothem uninstall --harness <name|all> [--project PATH] [--yes]

Opção	Descrição
`--harness <name>`	Nome do adaptador de ferramenta. Obrigatório.
`--project PATH`	Raiz do projeto para ferramentas com escopo de projeto.
`--yes`	Pula a confirmação.

`apothem verify`

Verifica se um adaptador de ferramenta está instalado e se seu caminho de saída está presente.

apothem verify --harness <name|all> [--project PATH]

Opção	Descrição
`--harness <name>`	Nome do adaptador de ferramenta ou `all`. Obrigatório.
`--project PATH`	Raiz do projeto para ferramentas com escopo de projeto.

O código de saída é 0 quando o adaptador está instalado e 1 quando não está.

`apothem profile`

Gerencia o perfil compartilhado do Apothem.

apothem profile show [--profile PATH]
apothem profile init [--profile PATH] [--force]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]

Subcomando	Descrição
`profile init`	Cria um esqueleto de perfil mínimo válido conforme o schema.
`profile show`	Imprime o perfil resolvido (YAML) no stdout.
`profile set <key> <value>`	Define um campo do perfil. O valor é analisado como YAML (strings, números, booleanos, listas e mapeamentos são todos aceitos).
`profile edit`	Abre o perfil no `$EDITOR` (recorre ao editor padrão da plataforma).

A opção --profile PATH aponta cada subcomando para um arquivo de perfil alternativo. Padrão: ~/.config/apothem/profile.yaml.

`apothem harnesses`

Lista e inspeciona os adaptadores de ferramenta registrados.

apothem harnesses list
apothem harnesses show <name>

Subcomando	Descrição
`harnesses list`	Imprime uma tabela de cada adaptador registrado com sua flag de status de instalação e o caminho de saída.
`harnesses show <name>`	Imprime o nome, o estado de instalação e o caminho de saída de um adaptador.

`apothem doctor`

Executa diagnósticos do sistema para a instalação do Apothem.

apothem doctor

Imprime a versão do Apothem, o interpretador Python, a plataforma, o caminho do perfil resolvido e uma tabela de status de instalação por ferramenta. O código de saída é 0 quando todo adaptador registrado relata estar instalado; caso contrário, 1.

Referência gerada de comandos e flags

Command	Flags	Description
`apothem completion`	—	Print a shell-completion script for SHELL to stdout. Supported shells: bash, zsh, fish, powershell. Every script is generated by Click's env-var completion protocol — PowerShell through the completion class registered above, since Click ships none natively. Enabling completion is opt-in: this command only prints the script — pipe or append it to the shell's completion file yourself (see `--help`).
`apothem diff`	`--format`, `--harness`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`	Preview the pending configuration changes for a single harness.
`apothem doctor`	`--format`, `--json`, `--no-color`, `--quiet, -q`, `--verbose, -v`	Report Apothem environment and installation health, exiting non-zero on any failure. Prints the engine version, Python, and platform, validates the shared profile against the packaged schema — a present-but-malformed profile is a failure, not a green "found" — and probes every registered adapter's install state. An adapter that raises degrades to an error row rather than aborting the sweep. Any failed check — an invalid profile, or a harness that is uninstalled or could not be probed — forces a non-zero exit so a CI or setup step can gate on it.
`apothem harnesses list`	`--format`, `--json`, `--no-color`, `--quiet, -q`, `--verbose, -v`	List all registered harness adapters.
`apothem harnesses show`	`--format`, `--json`, `--no-color`, `--quiet, -q`, `--verbose, -v`	Show details for a specific harness adapter.
`apothem install`	`--clean, --fresh`, `--dry-run`, `--format`, `--harness`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`, `--yes`	Install a harness adapter configuration.
`apothem migrate-workspace`	`--dry-run`, `--format`, `--json`, `--no-color`, `--project`, `--quiet, -q`, `--verbose, -v`	Migrate a legacy per-harness workspace into the shared `.apothem` layout. The base is the resolved `--project` root when supplied, otherwise the current working directory (the project-local default). Per-harness memory/contexts/learning stores union-merge into the shared store; a conflicting record is skipped, never overwritten; a legacy `.plans` tree moves under `.apothem/plans`; every consumed source is backed up first. The migration is idempotent.
`apothem profile edit`	`--format`, `--json`, `--no-color`, `--profile`, `--quiet, -q`, `--verbose, -v`	Open the shared profile in the system editor.
`apothem profile init`	`--force`, `--format`, `--json`, `--no-color`, `--profile`, `--quiet, -q`, `--verbose, -v`	Create a schema-valid shared profile scaffold.
`apothem profile set`	`--format`, `--json`, `--no-color`, `--profile`, `--quiet, -q`, `--verbose, -v`	Set a key in the shared profile. KEY is a dotted path that descends into the nested profile structure (`identity.name`, `preferences.style`, `enforcement.sprints`, `harnesses.<harness>.preferences.style`); a single key with no dot sets a top-level node. VALUE is stored as a literal string — bare words are not coerced (`no` stays `"no"`, `2024-01-01` and `1.0` stay strings) — except `true`/`false` (the boolean enforcement flags) and explicit `[...]`/`{...}` list/map input. The fully-assembled profile is validated against the packaged schema BEFORE writing; an invalid set is refused with the standard diagnostic and the profile on disk is unchanged.
`apothem profile show`	`--format`, `--json`, `--no-color`, `--profile`, `--quiet, -q`, `--verbose, -v`	Display the current shared profile.
`apothem quickstart`	`--format`, `--harness`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`, `--yes`	Guided first run: ensure a profile, preview the writes, then install. Walks a new operator through the canonical path in one linear flow — create a starter profile if none exists (with a personalize nudge), preview the files each harness will write (project root vs your home directory), confirm, then install with the grouped capability-note output — and ends with the recommended next commands. `--yes` runs the whole sequence non-interactively; `--format json` emits one structured summary of every step. It composes the install building blocks; it does not duplicate them.
`apothem rollback`	`--format`, `--harness`, `--install-id`, `--json`, `--last`, `--no-color`, `--project`, `--quiet, -q`, `--verbose, -v`, `--yes`	Restore a harness to the state before its recorded install.
`apothem status`	`--format`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`	Report install, verify, and drift state for every registered harness.
`apothem uninstall`	`--format`, `--harness`, `--json`, `--no-color`, `--project`, `--quiet, -q`, `--verbose, -v`, `--yes`	Remove a harness adapter configuration.
`apothem update`	`--dry-run`, `--format`, `--harness`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`	Re-install a harness adapter configuration from the current profile.
`apothem verify`	`--format`, `--harness`, `--json`, `--no-color`, `--profile`, `--project`, `--quiet, -q`, `--verbose, -v`	Verify a harness adapter installation. Without `--profile` the check is structural: every managed target must be present and valid. With `--profile` the check additionally requires profile fidelity, so a present-but-drifted install fails verify — answering "is THIS profile faithfully installed?" rather than merely "does it exist?".

Referência da CLI

On this page