CLI リファレンス
quickstart
apothem quickstart ガイド付き初回実行コマンドの CLI リファレンス。
ガイド付きの初回実行: プロファイルが存在することを確保し、書き込みをプレビューしてから、インストールします。
構文
apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
[--yes] [--quiet|-q] [--verbose|-v]
[--format plain|json] [--json] [--no-color]quickstart は、新しいオペレーター向けの唯一のガイド付きエントリーポイントです。
1 つの直線的なフローで、次のことを行います。(1) 共有プロファイルが存在することを確保します —— 見つからない場合は、自分用に書き換えるよう促す案内とともにスタータープロファイルを作成します。(2) 選択したハーネスが書き込む具体的なファイルを、プロジェクトルートとホームディレクトリに分けてプレビューします。(3) 確認を求めます。(4) グループ化されノイズを除いた機能注記の出力とともにインストールします。(5) 推奨される次のコマンドを出力します。
これは install コマンドが使用するのと同じ構成要素を組み合わせたもので、それらを再実装するものではありません。
--project のデフォルトはカレントディレクトリです。
--harness にはデフォルトがありません。省略された場合、quickstart はどのハーネスをインストールするかを尋ねるため、初回実行では 1 つのハーネスの設定が書き込まれます。
--harness all はサポートされているすべてのハーネスをインストールし、常に明示的な選択です。
動作
- ハーネス —
--harnessを省略すると、対話的な実行はサポートされている名前（とall）を一覧表示し、何かが書き込まれる前に 1 つを選ぶよう求めます。対話できない実行（--yes、--format json、またはターミナルなし）は、--harnessオプションの名前を挙げた使用法エラーで停止し、何も書き込みません。 - プロファイル — 解決されたプロファイルパスにファイルがない場合、
quickstartはスタータープロファイルの作成を提案します（--yes、非対話シェル、または--format jsonのもとでは自動的に作成されます）。そして、個人用に書き換えるべきプレースホルダーの識別フィールドの名前を挙げます。 - プレビューと確認 —
--harness allの場合、対象はプロジェクトルートとホームディレクトリという 2 つの見出しの下に一覧表示されます。対話的な実行では、プロジェクトの外に書き込む前に確認します。単一の名前で指定したハーネスは、プレビューも確認もなしにインストールされます。--yes、非対話シェル、--format jsonは、確認を求めずに続行します。--harness allのプレビューを拒否すると、インストールの書き込みより前に中止します。手順 1 で作成されたスタータープロファイルは残ります。 - インストール — ハーネスがネイティブにサポートしていない機能は、ハーネスごとに 1 つのグループ化された注記として要約されます（機能ごとの詳細は
--verboseで確認できます）。完全な一覧は、常に--format jsonの warnings 配列に含まれます。 - 次のステップ — ターミナルの出力は、後続のコマンド（
apothem verify …、apothem doctor）の名前を挙げます。
オプション
| オプション | 説明 |
|---|---|
--harness NAME | インストールするハーネスアダプター、またはレジストリ全体のセットを表す all。デフォルトはありません。対話的な実行では尋ねられ、非対話の実行ではこれを渡さなければなりません。 |
--profile PATH | 共有プロファイル YAML へのパス。デフォルトは ~/.config/apothem/profile.yaml です。 |
--project PATH | プロジェクトスコープのハーネス向けのプロジェクトルート。デフォルトはカレントディレクトリです。 |
--yes | ガイド付きシーケンス全体を非対話的に実行します（すべてのプロンプトをスキップします）。 |
--quiet, -q | 情報出力を抑制します。エラーのみが出力されます。 |
--verbose, -v | グループ化された注記の代わりに、投影されなかった各機能の理由を出力します。 |
--format plain|json | 出力形式（デフォルト: plain）。 |
--json | --format json の短縮形。 |
--no-color | 出力中の ANSI カラーコードを無効にします。 |
-h, --help | ヘルプを表示して終了します。 |
JSON 出力
--format json は、ガイド付きの各ステップを要約する単一のドキュメントを出力します。
{
"schema_version": 1,
"status": "success",
"command": "quickstart",
"profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
"steps": [
{"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
{"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
{"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
],
"recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}例
apothem quickstart # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes # every harness, explicitly
apothem quickstart --harness claude-code --json終了コード
| コード | 意味 |
|---|---|
| 0 | ガイド付きの実行が完了した |
| 1 | 想定された検証、プロファイル、ハーネス、プロジェクト、またはアダプターのエラー |
| 2 | 少なくとも 1 回の書き込みの後の、部分的なバッチのマテリアライズ |
| 64 | 使用法エラー: 不明なオプションまたはコマンド、あるいは欠落した、または無効なオプション値。--json のもとでは、エラーはコード cli.usage を持つ JSON エンベロープになります。 |
関連項目
- apothem install — 共有プロファイルからハーネスをマテリアライズする
- apothem verify — インストールが有効であることを確認する
- apothem doctor — 環境とインストールの健全性
- はじめに — 完全なインストールガイド