Skip to Content

agent — AI コーディングエージェント連携

AI コーディングエージェント(Claude Code / Cursor / GitHub Copilot 等)が、プロジェクトで使っている @orizm/cli のバージョンと整合した Orizm ドキュメントを、常に手元で参照できるようにします。

@orizm/cli には公開ドキュメント(docs.orizm.com )のスナップショットが node_modules/@orizm/cli/dist/docs/ に同梱されています。orizm agent init は、この同梱ドキュメントへの参照を AGENTS.md / CLAUDE.md に書き込み、エージェントが推測ではなく正確な情報に基づいて Orizm のコードを生成できるようにします。

同梱ドキュメントはインストール済みの @orizm/cli のバージョンと常に一致します。@orizm/cli を更新すれば、エージェントが参照するドキュメントも自動的に追従します。SDK のページには対応する @orizm/cms-sdk / @orizm/consumer-sdk のバージョンが記載されていますが、これは @orizm/cli を publish した時点のものです。SDK は @orizm/cli と独立して更新されるため、プロジェクトにインストールされているバージョンとは異なることがあります。

この機能を使うには @orizm/cliプロジェクトの devDependency として追加してください。書き込まれる参照は ./node_modules/@orizm/cli/dist/docs/ というプロジェクト相対パスで、プロジェクトにインストールされた @orizm/cli の docs を指します。npm install -g @orizm/cli のようなグローバルインストールだけでは、このパスは解決されません(他の orizm コマンドはグローバルでも動作しますが、agent 連携はプロジェクト依存が前提です)。参照が解決できない場合、orizm agent init は警告を表示します。

orizm agent init

AGENTS.mdCLAUDE.md に、同梱ドキュメントへの参照ブロックを追記します。サーバー通信は行いません。

orizm agent init

既定では 2 つのファイルを管理します。

  • AGENTS.md(正本): 同梱ドキュメントの場所と索引、バージョン整合の確認手順、Starter Kit v2 の規約を書き込みます。多くのエージェントが読むオープン標準です。
  • CLAUDE.md: 本文は複製せず、@AGENTS.mdAGENTS.md を取り込みます。Claude Code は CLAUDE.md を入口として読み込むため、この import 経由で同じ内容を参照します。

再実行しても内容は重複しません。参照ブロックは <!-- orizm-agent:start --><!-- orizm-agent:end --> のマーカーで管理され、既存の記述を壊さずに更新されます。

オプション

オプション説明
--target <file>指定した 1 ファイルだけに本文を書き込みます(例: --target AGENTS.md)。省略時は AGENTS.mdCLAUDE.md の両方を管理します。
--cwd <dir>対象プロジェクトのルート。省略時はカレントディレクトリです。
--dry-runファイルを書き換えず、変更内容だけを表示します。
--yes書き込み前の確認プロンプトをスキップします。

書き込み前に内容を確認したい場合は --dry-run を使います。

orizm agent init --dry-run

orizm agent init は認証もプロジェクトコンテキストも必要としないローカル専用コマンドです。同梱ドキュメントが見つからない場合(@orizm/clinode_modules に無い等)はエラーになります。その場合は依存関係を再インストールしてください。

対応するエージェントがドキュメントを読み込むかは各ツールの実装に依存します。本コマンドは少なくとも Claude Code を基準としています。Cursor / GitHub Copilot などツール固有の指示ファイルへの対応は今後の拡張予定です。

Last updated on