Referensi CLI

CLI apothem adalah antarmuka operator utama untuk mengelola profil bersama dan adapter harness.

Flag global

Flag	Deskripsi
`--version`	Mencetak versi Apothem lalu keluar
`--help`	Mencetak bantuan untuk perintah

Subperintah

`apothem install`

Memasang sebuah adapter harness dari profil bersama.

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

Opsi	Deskripsi
`--harness <name>`	Nama adapter harness (lihat nilai kanonis di bawah). Wajib.
`--profile PATH`	Jalur ke YAML profil bersama. Bawaannya `~/.config/apothem/profile.yaml`.
`--project PATH`	Root proyek untuk harness berlingkup proyek.
`--dry-run`	Pratinjau pemasangan tanpa menulis berkas.
`--clean`, `--fresh`	Awal bersih yang bersifat opt-in: mencadangkan lalu menghapus status pemasangan sebelumnya (`~/.claude`, `~/.codex`, `~/.agents`, `~/.config/apothem`) sebelum memasang.
`--yes`	Melewati konfirmasi per target selama penghapusan awal bersih (wajib untuk eksekusi `--clean` non-interaktif).

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
zed

Gunakan --harness all --project <path> untuk memilih kumpulan seluruh registri. Daftar exclude_harnesses pada profil dihormati saat pemilihan batch install/update.

`apothem update`

Menurunkan ulang konfigurasi native sebuah adapter harness dari profil bersama saat ini.

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

Opsi	Deskripsi
`--harness <name>`	Nama adapter harness. Wajib.
`--profile PATH`	Jalur 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 memutakhirkan mesin Apothem itu sendiri; mutakhirkan mesin melalui kanal yang Anda gunakan untuk memasangnya (alur /plugin, npx, atau skrip installer dan pembaruan), seperti dijelaskan di Memperbarui.

`apothem uninstall`

Menghapus konfigurasi native sebuah adapter harness.

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

Opsi	Deskripsi
`--harness <name>`	Nama adapter harness. Wajib.
`--project PATH`	Root proyek untuk harness berlingkup proyek.
`--yes`	Melewati prompt konfirmasi.

`apothem verify`

Memverifikasi bahwa target terkelola sebuah adapter harness ada dan valid.

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

Opsi	Deskripsi
`--harness <name>`	Nama adapter harness atau `all`. Wajib.
`--profile PATH`	YAML profil bersama yang menjadi acuan pemeriksaan kesetiaan. Tanpanya, pemeriksaan murni struktural.
`--project PATH`	Root proyek untuk harness berlingkup proyek.

Tanpa --profile, pemeriksaannya struktural: setiap target terkelola harus ada dan valid. Dengan --profile, pemeriksaan juga menuntut kesetiaan, sehingga pemasangan yang ada tetapi telah menyimpang dari profil itu gagal verify — gunakan opsi ini untuk memastikan sebuah profil tertentu terpasang dengan setia.

Kode keluar adalah 0 saat harness terverifikasi (dan, dengan --profile, setia terhadapnya), 1 saat sebuah target hilang atau tidak valid, atau saat --profile diberikan dan pemasangan telah menyimpang.

`apothem status`

Melaporkan status pemasangan, verifikasi, dan penyimpangan untuk setiap harness yang terdaftar.

apothem status [--profile PATH] [--project PATH]

Opsi	Deskripsi
`--profile PATH`	Profil bersama yang dipakai sebagai acuan penyimpangan. Profil bawaan yang tidak terbaca menurunkan status penyimpangan menjadi `unknown` alih-alih membatalkan sapuan.
`--project PATH`	Root proyek untuk harness berlingkup proyek. Tanpanya, harness tersebut melaporkan `needs-project`.

Setiap baris memasangkan flag installed dengan flag verified, dan keduanya bergabung menjadi status penyimpangan:

Status	Arti
`absent`	Apothem belum memasang ke harness ini.
`in-sync`	Terpasang dan cocok dengan profil acuan.
`drift`	Terpasang tetapi tidak lagi cocok — perbaiki dengan `apothem update`.
`unknown`	Terpasang, tetapi profil acuan tidak dapat dibaca.
`needs-project`	Harness lingkup proyek dilaporkan tanpa `--project`, sehingga targetnya tidak dapat diselesaikan.

installed menjawab "apakah Apothem memasang di sini?", bukan "apakah harness ini ada di mesin?". Flag ini berpatokan pada artefak milik Apothem sendiri — blok terkelola di dalam jangkar instruksi, dan konten di bawah subtree .apothem/ milik Apothem — tidak pernah pada berkas milik vendor yang ditulis harness untuk dirinya sendiri. Harness yang direktori konfigurasinya ada tetapi tidak pernah disentuh Apothem melaporkan absent, dan harness yang telah dicopot melaporkan absent meskipun direktori yang telah dikosongkan masih tersisa.

`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 di-resolve sebagai JSON ke stdout. Dengan `--json`, dokumen diawali dengan `schema_version`.
`profile set <key> <value>`	Menetapkan sebuah field profil. Nilainya disimpan sebagai string literal — kata polos tidak dikonversi, sehingga `no` tetap `"no"` dan `1.0` tetap string — kecuali `true`/`false` serta masukan daftar dan map eksplisit `[...]` / `{...}`. Profil yang telah dirakit divalidasi terhadap skema sebelum ditulis.
`profile edit`	Membuka profil di `$EDITOR` (beralih ke bawaan platform sebagai cadangan).

Opsi --profile PATH mengarahkan setiap subperintah ke berkas profil alternatif. Bawaannya ~/.config/apothem/profile.yaml.

`apothem harnesses`

Mendaftar dan memeriksa adapter harness yang terdaftar.

apothem harnesses list
apothem harnesses show <name>

Subperintah	Deskripsi
`harnesses list`	Mencetak tabel setiap adapter terdaftar beserta flag status terpasang dan jalur keluarannya.
`harnesses show <name>`	Mencetak nama, status terpasang, dan jalur keluaran untuk satu adapter.

`apothem doctor`

Menjalankan diagnostik sistem untuk pemasangan Apothem.

apothem doctor

Mencetak versi Apothem, interpreter Python, platform, jalur profil yang telah di-resolve, dan tabel status pemasangan per harness. Kode keluar adalah 1 ketika ada pemeriksaan yang gagal: profil tidak valid, harness yang terpasang tetapi tidak lolos verifikasi, perintah hook terdaftar yang tidak dapat dimulai, adapter yang tidak dapat dimuat atau diperiksa, atau ledger yang tidak dapat dibaca. Harness yang belum terpasang dilaporkan dan bukan kegagalan, serta catatan informasional tidak mengubah kode keluar.

Referensi Perintah dan Flag yang Dihasilkan

Command	Flags	Description
`apothem backups prune`	`--dry-run`, `--format`, `--harness`, `--json`, `--keep`, `--no-color`, `--quiet, -q`, `--verbose, -v`	Delete backup sets and install records beyond the newest N per harness. Keeps the newest N backup sets under ~/.apothem/backups/ for each selected harness, and the newest N install records per install root in its ledger under ~/.apothem/state/. A backup set that a kept record, or the latest install record of any install root, still references is never deleted, so rollback of the latest install still restores.
`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`, `--project`, `--quiet, -q`, `--verbose, -v`	Check the installed harnesses and the shared profile; exit 1 on any failure. Reports the engine version, Python, and platform; validates a present shared profile against the packaged schema; and, for every installed harness, runs the adapter's verify and starts each hook command the install registered with a no-op payload. A harness that is not installed is reported but is not a failure, so a machine with one healthy harness passes. Project-scope harnesses are checked when --project names their root.
`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. Without `--harness` it asks which harness to install, so the first run writes one harness's configuration rather than all of them; `all` is an explicit choice. A run that cannot ask fails with a usage error before anything is written.
`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?".

Referensi CLI

Flag globalCopy Anchor Link

SubperintahCopy Anchor Link

apothem installCopy Anchor Link

apothem updateCopy Anchor Link

apothem uninstallCopy Anchor Link

apothem verifyCopy Anchor Link

apothem statusCopy Anchor Link

apothem profileCopy Anchor Link

apothem harnessesCopy Anchor Link

apothem doctorCopy Anchor Link

Referensi Perintah dan Flag yang DihasilkanCopy Anchor Link

On this page