クイックスタート
Apothem をインストールし、プロファイルを作成し、最初のハーネスをマテリアライズして検証する — 期待される出力付きの、コピー＆ペーストで進めるツアー。
これは、何もない状態から検証済みのハーネス構成に至る最短経路です。インストールし、共有プロファイルを作成し、1 つのツールのネイティブ設定をマテリアライズし、それを確認し、最初の編集を行います。 すべてのコマンドは実在し、コピー＆ペーストでそのまま実行でき、各ステップはクリーンな実行で何が出力されるかを示します。 インストール自体は 2 分未満で完了します。プロファイルの編集は、あなたが望むだけの時間がかかる唯一の部分です。
終わるころには、あなたが書いたプロファイルから生成された、動作するハーネス構成が手元にあります — そして、プロファイルの変更を 1 つのツールまたはすべてのツールへ送り出し直す 1 つのコマンドも分かるようになります。
説明付きの、ゆっくり進む版が必要ですか？
入門チュートリアルは、同じ範囲を、各ステップとそれが重要な理由をより詳しく説明しながら進みます。 このページは、簡潔で出力を主体としたツアーです。
例のハーネスとして Claude Code を使います — これはインストーラーのデフォルトです。 別のツールを対象にするには、どのステップでもアダプター名を差し替えてください。サポートされているすべての名前はハーネス一覧にあります。
1. Apothem をインストールする
Apothem は自己完結型ランタイムとして出荷されます——エンジンは、ベンダリングされた依存関係とともに、そのソースツリーから直接実行されます。1 つのコマンドでソースを取得し、エンジンを配置して、最初のハーネスをマテリアライズします。インストーラーは署名済みリリースを最初に検証するため、最初のインストールの前に一度、メンテナーの署名鍵をインポートし、フィンガープリントが 5C89 98F9 F241 7204 45D3 F28B 7039 6FED 9C63 4163 と表示されることを確認してください:
curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import
gpg --fingerprint 70396FED9C634163& "$env:ProgramFiles\Git\bin\bash.exe" -c 'curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import && gpg --fingerprint 70396FED9C634163'その後、インストーラーを実行します:
curl -fsSL https://apothem.ahmedgad.com/install.sh | bashirm https://apothem.ahmedgad.com/install.ps1 | iexインストーラーには、システムの Python 3.10+ が必要で、ネットワーク形式の場合はさらに git と gpg が必要です。インストーラーは前提条件をチェックし、エンジンを ~/.apothem 配下に配置します。click または rich が不足している場合、インストーラーは、あなたの確認を得たうえで、または --yes（PowerShell では -Yes）か APOTHEM_AUTO_INSTALL_DEPS=1 が指定されている場合に、そのパッケージをインストールします。それ以外の場合は、実行すべき pip コマンドを示して停止します（前提条件の一覧を参照）。完了時には次のステップのバナーを表示します。POSIX で、シムのディレクトリがすでに PATH 上にある場合、バナーは次のようになります:
Installation complete.
The 'apothem' command is on your PATH.
Recommended first step — the guided setup (profile -> preview -> install):
apothem quickstartプロファイルなしでの初回実行
まだプロファイルがない場合、インストーラーはサンプルプロファイルを ~/.config/apothem/profile.yaml にコピーし、そのまま続行します。同じ実行の中で最初のハーネスをマテリアライズし、それを検証します。
サンプルの識別情報フィールドはプレースホルダーであるため、インストールは注意書きを出力します。
ステップ 2 でプロファイルを自分のものにし、ステップ 5 と同様に apothem update --harness <name> で適用してください。
`apothem` コマンド
インストーラーは apothem シムを $HOME/.local/bin（POSIX）または %LOCALAPPDATA%\Microsoft\WindowsApps（Windows）に書き込み、PATH は決して編集しません。
そのディレクトリが PATH 上にあれば、エンジンを apothem <command> として直接実行します。
まだ PATH 上にない場合、バナーはシムを必要としない自己完結型のフォールバック — PYTHONPATH="$HOME/.apothem/src" python3 -m apothem <command> — を出力します。各コマンドの前に、バナーが出力した正確なプレフィックスを付けてください。
インストールガイドは、環境変数のオプションとあわせて、その他のインストール経路 — Claude Code プラグイン（/plugin marketplace add ahmed-g-gad/apothem の後に /plugin install apothem@apothem）、VS Code 系およびその他のツールネイティブな拡張機能、そしてオンデマンドの npx 形式（npx @ahmed-g-gad/apothem <command>） — を扱います。
2. 共有プロファイルを作成する
apothem profile init は、スキーマ上有効な最小のプロファイルを ~/.config/apothem/profile.yaml に書き込みます。
そこにすでにプロファイルがある場合（ステップ 1 でインストーラーがサンプルをコピーした場合など）、init はエラーで停止し、ファイルは変更しません。上書きするには --force を渡すか、ファイルをそのまま残して下に示すように編集してください。
プロジェクト固有または CI 固有のプロファイルを別の場所に置いている場合は、--profile PATH を渡します。
apothem profile init
apothem profile show --jsonこのスキャフォールドは架空のプレースホルダーの識別情報を使用しており、ハーネスの出力をインストールする前に編集しても安全です。
show --json はそれを読み戻し、schema_version から始まる、すべてのデフォルトが埋められた検証済みのプロファイルを報告します。
コマンドはそれを 1 行で出力します。ここでは展開して示します。
{
"schema_version": 1,
"identity": {
"name": "Example User",
"role": "senior software engineer",
"email": "[email protected]",
"github": "example-user"
},
"preferences": {
"language": "python",
"style": "concise"
},
"rules": [],
"seriousness": "PERSONAL_USE",
"enforcement": {
"sprints": false,
"agent_teams": false,
"multitasking": false,
"continuous_execution": false,
"learning_loop": false
},
"mcp_servers": {},
"agent_mcp_servers": {},
"harnesses": {},
"exclude_harnesses": [],
"workspace": {
"directory_name": ".apothem",
"scope": "project-local"
}
}不正な形式の編集が表面化するのもここです — YAML が無効な場合、ハーネス設定が書き込まれる前に、show がここでそれを報告します。
apothem profile edit（エディターでプロファイルを開きます）でプロファイルを自分のものにするか、1 つのキーをその場で設定します。
apothem profile set identity.name "Your Name"3. ハーネスアダプターをインストールする
主に使うハーネスのアダプターをマテリアライズします。 これはあなたのプロファイルを読み取り、そのツールのネイティブ設定を書き込みます。
apothem install --harness claude-code✓ Installed claude-code -> /home/you/.claude/settings.jsonプロジェクトスコープのアダプターはルールファイルをプロジェクトの内部に書き込むため、--project PATH が必要です。そのうち 7 つは、スキルと共有ルールもホームディレクトリ内のフォルダーに書き込み、--project はそれらの書き込み先を変えません。
--dry-run を使うと、ファイルを書き込まずに任意のインストールをプレビューできます。
apothem install --harness cursor --project . --dry-run
apothem install --harness cursor --project .--harness all を使うと、レジストリに登録されたセット全体を一度にインストールできます。この選択はプロジェクトスコープとユーザースコープの両方のファイルを書き込むため、コマンドは具体的な対象を場所ごとにまとめて表示します。対話型のターミナルでは、プロジェクトルートの外に書き込む前に確認を求めます。ターミナルがない実行、--yes を付けた実行、--format json を付けた実行は、確認なしで書き込みます。--dry-run は何も書き込みません。セット全体は、次のコマンドで実行します。
apothem install --harness all --project .サポートされているすべての名前はハーネスの完全な一覧を、オプションの全体は install リファレンスを参照してください。
4. 検証する
マテリアライズは作業の半分にすぎません。verify で、ハーネスに期待される設定ファイルが配置され、有効であることを確認します。
apothem verify --harness claude-code✓ claude-code is verified at /home/you/.claude/settings.json管理対象のターゲットが欠けている場合、管理対象のファイルが空の場合、または JSON か YAML の設定が解析できない場合、verify は非ゼロで終了します。--profile PATH を追加すると、インストールされたファイルがそのプロファイルと異なる場合にも失敗するようになり、verify はドリフトのチェックとして機能します。指定しない場合、古い設定でも検証に通ります。非ゼロの終了コードにより、verify をセットアップスクリプトのゲートとして使えます。登録済みのすべてのアダプターを対象とする、マシン全体のヘルスチェックを行うには、次を実行します。
apothem doctordoctor はインストール済みのすべてのハーネスをチェックします。各ハーネスは検証に合格しなければならず、そのインストールが登録した各フックコマンドは起動しなければなりません。
インストールしていないハーネスは一覧に表示されますが失敗にはならないため、失敗するチェックがなければ、インストール済みのハーネスが 1 つだけであっても doctor は 0 で終了します。
5. 初回実行
設定したばかりのハーネス — この例では Claude Code — を開き、任意のプロジェクトでセッションを開始します。 ステップ 2 で設定したプロファイルは、いまやそのツールの振る舞いの一部です。 これが動作する初回実行です。1 つのプロファイルが、実際のセッションを形作っています。
後でプロファイルを変更したときは、再インストールせずに再適用します。
apothem update --harness claude-code別のアダプターを指定すると、そのツールにプロファイルを再適用します（プロジェクトスコープのアダプターの場合は --project PATH を追加します）。サポートされているすべてのハーネスに再適用するには、--harness all --project . を渡します。
次のステップ
- さらにハーネスを追加する — ツールごとにステップ 3 を繰り返します。
- 最初のルールを書く — すべてのハーネスが継承する単位です。
- プランを作成する — ミッション全体を、決定的なプランパイプラインを通して進めます。
- CLI リファレンス — すべてのコマンド、フラグ、終了コード。