作成 & パイプラインのハウツー
コンテンツを仕様へ磨き上げ、プランスイートを生成し、プランをレビューし、フェーズを実行し、アーティファクトを追加し、品質ゲートを実行するための、タスク指向のウォークスルー。
Apothem のアーティファクトを作成し、プランパイプラインを駆動するためのタスク指向のウォークスルーです。各ガイドは、一つの具体的な問いに答えます。
初回セットアップのレシピ(ハーネスの追加、プロファイルの編集、インストーラーの操作)については、代わりに ハウツーレシピ セクションを参照してください。
プランスイートのパイプライン
生のコンテンツを仕様へ洗練するには?
生のコンテンツを入力として /plan-spec を起動します。Forge の役割が 6 つの変換フェーズ(Discovery、Meticulous Consideration、Potency Mapping、Preservation Verification、Expertise Application、Question-Resolution Sweep)を実行し、統合された仕様を .apothem/plans/{suite}/_spec/spec.md に出力します。完全なプロトコルについては src/apothem/commands/plan-spec.md を参照してください。
仕様からプランスイートを生成するには?
/plan-spec が仕様を書き出したら、/plan-generate .apothem/plans/{suite}/_spec/spec.md を起動します。ジェネレーターは、正規のインフラファイルと、フェーズごとの phases/NN-kebab-topic/PHASE.md ファイルを出力します。src/apothem/commands/plan-generate.md を参照してください。
生成されたプランをレビューするには?
/plan-review path/to/plan-suite/ を起動します。レビュアーは 9 つのプランニング手法を適用し、スコアカードを出力します。失敗したスコアカードは、解決されるまで SHARED+ での実行をブロックします。src/apothem/commands/plan-review.md を参照してください。
プランを実行するには?
/plan-execute path/to/plan-suite/ [phase-id] を起動します。phase-id を指定しない場合は、次の保留中フェーズが実行されます。特定の id を指定すると、そのフェーズのみが実行されます。src/apothem/commands/plan-execute.md を参照してください。
プランの状況を確認するには?
/plan-status path/to/plan-suite/ [--verbose] を起動します。読み取り専用のレポートです。src/apothem/commands/plan-status.md を参照してください。
アーティファクトの作成
新しいルールを追加するには?
src/apothem/rules/配下に kebab-case のファイル名を選びます。例:src/apothem/rules/my-new-rule.md。- フロントマター(
name、description、pathFilter、alwaysApply)を作成します。 - 正規のセクション(Purpose、Obligations、Seriousness Scaling、 Anti-Patterns、Enforcement、Bindings)で本文を書きます。
python scripts/dev/validate_ecosystem.py --check frontmatter-cohortを実行して検証します。
ルールローダーは glob ベースで、src/apothem/rules/*.md に一致するすべてのファイルを読み込みます。そのため、レジストリへの登録は不要です。正規の名前のファイルをディレクトリに置くことが、登録のすべてです。
新しい委任ワーカーを追加するには?
下記のディレクトリ配下に、my-worker.md の形式で kebab-case のファイル名を選びます:
src/apothem/agents/
src/apothem/agents/my-worker.md次に:
-
フロントマターを作成します。
name、version、updated、description、tools、disallowedTools、maxTurns、およびeffortを含めます。 -
システムプロンプトを本文として書きます。
委任ワーカーコホートは src/apothem/agents/*.md から glob で読み込まれるため、正規の名前のファイルは配置するだけで取り込まれます。編集すべきレジストリの表はありません。
新しいフックを追加するには?
src/apothem/hooks/messages/<event>-<scope>.md配下に コンテキストメッセージを作成します。settings.jsonでフックを接続します。- フックパイプラインを更新します。
python scripts/dev/validate_ecosystem.pyを実行します。
品質ゲート
ローカルの品質ゲートを実行するには?
python -m ruff check .
python -m ruff format --check .
python -m mypy
python -m pytest -q
python scripts/dev/validate_ecosystem.py
python scripts/dev/chaos_pass.pyCI パイプラインは同じセットを並行して実行します。
単一のアーティファクトクラスのフロントマターを確認するには?
python scripts/dev/validate_ecosystem.py --check frontmatter-cohort