Referensi CLI
Referensi CLI Apothem — semua subperintah dan flag.
CLI apothem adalah antarmuka operator utama untuk mengelola profil bersama dan
adaptor harness.
Flag global
| Flag | Deskripsi |
|---|---|
--version | Mencetak versi Apothem dan keluar |
--help | Mencetak bantuan untuk perintah |
Subperintah
apothem install
Memasang adaptor harness dari profil bersama.
apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| Opsi | Deskripsi |
|---|---|
--harness <name> | Nama adaptor harness (lihat nilai kanonis di bawah). Wajib. |
--profile PATH | Path ke YAML profil bersama. Default-nya ~/.config/apothem/profile.yaml. |
--project PATH | Root proyek untuk harness berlingkup proyek. |
--dry-run | Pratinjau pemasangan tanpa menulis berkas. |
Nilai --harness kanonis:
antigravity
claude-code
codebuddy
codex
cursor
gemini-cli
github-copilot
glm
hermes
kimi-code
kiro
open-claw
opencode
qwen-code
trae
windsurf
zedGunakan --harness all --project <path> untuk memilih kumpulan seluruh
registri. Daftar exclude_harnesses pada profil dihormati selama pemilihan batch
pemasangan/pembaruan.
apothem update
Menurunkan ulang konfigurasi native sebuah adaptor harness dari profil bersama saat ini.
apothem update --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| Opsi | Deskripsi |
|---|---|
--harness <name> | Nama adaptor harness. Wajib. |
--profile PATH | Path ke YAML profil bersama. |
--project PATH | Root proyek untuk harness berlingkup proyek. |
--dry-run | Pratinjau pembaruan tanpa menulis berkas. |
update mematerialisasi ulang keluaran harness. Perintah ini tidak memperbarui
paket CLI Apothem; untuk peningkatan paket, gunakan pengelola paket yang dipakai
memasang Apothem.
apothem uninstall
Menghapus konfigurasi native sebuah adaptor harness.
apothem uninstall --harness <name|all> [--project PATH] [--yes]| Opsi | Deskripsi |
|---|---|
--harness <name> | Nama adaptor harness. Wajib. |
--project PATH | Root proyek untuk harness berlingkup proyek. |
--yes | Melewati prompt konfirmasi. |
apothem verify
Memverifikasi bahwa sebuah adaptor harness terpasang dan path keluarannya ada.
apothem verify --harness <name|all> [--project PATH]| Opsi | Deskripsi |
|---|---|
--harness <name> | Nama adaptor harness atau all. Wajib. |
--project PATH | Root proyek untuk harness berlingkup proyek. |
Kode keluar adalah 0 saat adaptor terpasang, dan 1 saat tidak.
apothem profile
Mengelola profil bersama Apothem.
apothem profile show [--profile PATH]
apothem profile init [--profile PATH] [--force]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]| Subperintah | Deskripsi |
|---|---|
profile init | Membuat kerangka profil minimal yang valid menurut skema. |
profile show | Mencetak profil yang telah diselesaikan (YAML) ke stdout. |
profile set <key> <value> | Menetapkan sebuah field profil. Nilainya diurai sebagai YAML (string, angka, boolean, daftar, dan pemetaan semuanya diterima). |
profile edit | Membuka profil di $EDITOR (jatuh ke editor default platform). |
Opsi --profile PATH mengarahkan tiap subperintah ke berkas profil alternatif.
Default-nya ~/.config/apothem/profile.yaml.
apothem harnesses
Mendaftar dan memeriksa adaptor harness yang terdaftar.
apothem harnesses list
apothem harnesses show <name>| Subperintah | Deskripsi |
|---|---|
harnesses list | Mencetak tabel setiap adaptor terdaftar beserta flag status pemasangan dan path keluarannya. |
harnesses show <name> | Mencetak nama, status pemasangan, dan path keluaran sebuah adaptor. |
apothem doctor
Menjalankan diagnostik sistem untuk pemasangan Apothem.
apothem doctorMencetak versi Apothem, interpreter Python, platform, path profil yang
diselesaikan, dan tabel status pemasangan per harness. Kode keluar adalah 0
saat setiap adaptor terdaftar melaporkan terpasang; selain itu 1.
Referensi Perintah dan Flag yang Dihasilkan
| 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?". |