Skip to content
Apothem
リファレンス

CLI リファレンス

Apothem CLI リファレンス — すべてのサブコマンドとフラグ。

apothem CLI は、共有プロファイルとハーネスアダプターを管理するための主要な オペレーターインターフェースです。

グローバルフラグ

フラグ説明
--versionApothem のバージョンを表示して終了します
--helpコマンドのヘルプを表示します

サブコマンド

apothem install

共有プロファイルからハーネスアダプターをインストールします。

apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]
オプション説明
--harness <name>ハーネスアダプター名(下記の正規の値を参照)。必須。
--profile PATH共有プロファイル YAML へのパス。デフォルトは ~/.config/apothem/profile.yaml
--project PATHプロジェクトスコープのハーネス向けのプロジェクトルート。
--dry-runファイルを書き込まずにインストールをプレビューします。

正規の --harness の値:

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

レジストリ全体の集合を選択するには --harness all --project <path> を使用します。 プロファイルの exclude_harnesses リストは、インストール/更新のバッチ選択時に 尊重されます。

apothem update

現在の共有プロファイルから、ハーネスアダプターのネイティブ設定を再導出します。

apothem update --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]
オプション説明
--harness <name>ハーネスアダプター名。必須。
--profile PATH共有プロファイル YAML へのパス。
--project PATHプロジェクトスコープのハーネス向けのプロジェクトルート。
--dry-runファイルを書き込まずに更新をプレビューします。

update はハーネスの出力を再マテリアライズします。Apothem CLI パッケージ自体は 更新しません。パッケージのアップグレードには、Apothem をインストールした パッケージマネージャーを使用してください。

apothem uninstall

ハーネスアダプターのネイティブ設定を削除します。

apothem uninstall --harness <name|all> [--project PATH] [--yes]
オプション説明
--harness <name>ハーネスアダプター名。必須。
--project PATHプロジェクトスコープのハーネス向けのプロジェクトルート。
--yes確認プロンプトをスキップします。

apothem verify

ハーネスアダプターがインストールされており、その出力パスが存在することを検証します。

apothem verify --harness <name|all> [--project PATH]
オプション説明
--harness <name>ハーネスアダプター名、または all。必須。
--project PATHプロジェクトスコープのハーネス向けのプロジェクトルート。

アダプターがインストールされている場合の終了コードは 0、そうでない場合は 1 です。

apothem profile

共有 Apothem プロファイルを管理します。

apothem profile show [--profile PATH]
apothem profile init [--profile PATH] [--force]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]
サブコマンド説明
profile initスキーマに準拠した最小限のプロファイルのひな型を作成します。
profile show解決済みのプロファイル(YAML)を stdout に表示します。
profile set <key> <value>プロファイルのフィールドを設定します。値は YAML としてパースされます(文字列、数値、ブール値、リスト、マッピングがすべて受け付けられます)。
profile edit$EDITOR でプロファイルを開きます(プラットフォーム既定のエディターにフォールバックします)。

--profile PATH オプションは、各サブコマンドを別のプロファイルファイルに向けます。 デフォルトは ~/.config/apothem/profile.yaml

apothem harnesses

登録済みのハーネスアダプターを一覧表示し、検査します。

apothem harnesses list
apothem harnesses show <name>
サブコマンド説明
harnesses list登録済みの各アダプターを、そのインストール状態フラグと出力パスとともに表として表示します。
harnesses show <name>1 つのアダプターの名前、インストール状態、出力パスを表示します。

apothem doctor

Apothem インストールのシステム診断を実行します。

apothem doctor

Apothem のバージョン、Python インタープリター、プラットフォーム、解決された プロファイルパス、およびハーネスごとのインストール状態の表を出力します。登録済みの すべてのアダプターがインストール済みを報告した場合の終了コードは 0、そうでない 場合は 1 です。

生成されたコマンドとフラグのリファレンス

CommandFlagsDescription
apothem completionPrint 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, -vPreview the pending configuration changes for a single harness.
apothem doctor--format, --json, --no-color, --quiet, -q, --verbose, -vReport 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, -vList all registered harness adapters.
apothem harnesses show--format, --json, --no-color, --quiet, -q, --verbose, -vShow details for a specific harness adapter.
apothem install--clean, --fresh, --dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yesInstall a harness adapter configuration.
apothem migrate-workspace--dry-run, --format, --json, --no-color, --project, --quiet, -q, --verbose, -vMigrate 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, -vOpen the shared profile in the system editor.
apothem profile init--force, --format, --json, --no-color, --profile, --quiet, -q, --verbose, -vCreate a schema-valid shared profile scaffold.
apothem profile set--format, --json, --no-color, --profile, --quiet, -q, --verbose, -vSet 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.&lt;harness&gt;.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 [...]/&#123;...&#125; 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, -vDisplay the current shared profile.
apothem quickstart--format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yesGuided 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, --yesRestore a harness to the state before its recorded install.
apothem status--format, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -vReport install, verify, and drift state for every registered harness.
apothem uninstall--format, --harness, --json, --no-color, --project, --quiet, -q, --verbose, -v, --yesRemove a harness adapter configuration.
apothem update--dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -vRe-install a harness adapter configuration from the current profile.
apothem verify--format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -vVerify 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?".

On this page