日本語
ドキュメント
ルール

ルール

opencodeのカスタム指示を設定します。

AGENTS.mdファイルを作成することで、opencodeにカスタム指示を提供できます。これはCursorのルールに似ています。特定のプロジェクト向けに動作をカスタマイズするためにLLMのコンテキストに含まれる指示が含まれています。


初期化

新しいAGENTS.mdファイルを作成するには、opencodeで/initコマンドを実行します。

ヒント: プロジェクトのAGENTS.mdファイルをGitにコミットすることをお勧めします。

これにより、プロジェクトとそのすべての内容をスキャンしてプロジェクトの目的を理解し、その情報を含むAGENTS.mdファイルを生成します。これにより、opencodeがプロジェクトをより適切にナビゲートできるようになります。

既存のAGENTS.mdファイルがある場合、これは追加を試みます。


このファイルを手動で作成することもできます。AGENTS.mdファイルに入れることができる内容の例を以下に示します。

AGENTS.md

ここでプロジェクト固有の指示を追加しており、これはチーム全体で共有されます。


タイプ

opencodeは複数の場所からAGENTS.mdファイルを読み取ることもサポートしています。これは異なる目的に役立ちます。

プロジェクト

プロジェクト固有のルール用にプロジェクトルートにAGENTS.mdを配置します。これらはこのディレクトリまたはそのサブディレクトリで作業している場合にのみ適用されます。

グローバル

~/.config/opencode/AGENTS.mdファイルにグローバルルールを設定することもできます。これはすべてのopencodeセッションに適用されます。

これはGitにコミットされたりチームと共有されたりしないため、LLMが従うべき個人的なルールを指定するために使用することをお勧めします。

Claude Code互換性

Claude Codeから移行するユーザー向けに、OpenCodeはClaude Codeのファイル規約をフォールバックとしてサポートしています:

  • プロジェクトルール:プロジェクトディレクトリのCLAUDE.mdAGENTS.mdがない場合に使用)
  • グローバルルール~/.claude/CLAUDE.md~/.config/opencode/AGENTS.mdがない場合に使用)
  • スキル~/.claude/skills/ — 詳細はエージェントスキルを参照

Claude Code互換性を無効にするには、以下の環境変数のいずれかを設定します:

Terminal window

優先順位

opencodeが起動すると、以下の順序でルールファイルを探します:

  • ローカルファイル:現在のディレクトリから上方向にトラバース(AGENTS.mdCLAUDE.md
  • グローバルファイル~/.config/opencode/AGENTS.md
  • Claude Codeファイル~/.claude/CLAUDE.md(無効化されていない場合)

各カテゴリで最初に一致したファイルが優先されます。例えば、AGENTS.mdCLAUDE.mdの両方がある場合、AGENTS.mdのみが使用されます。同様に、~/.config/opencode/AGENTS.md~/.claude/CLAUDE.mdより優先されます。


カスタム指示

opencode.jsonまたはグローバルの~/.config/opencode/opencode.jsonでカスタム指示ファイルを指定できます。これにより、あなたとチームはAGENTS.mdに複製することなく既存のルールを再利用できます。

例:

opencode.json

リモートURLを使用してWebから指示を読み込むこともできます。

opencode.json

リモート指示は5秒のタイムアウトでフェッチされます。

すべての指示ファイルはAGENTS.mdファイルと結合されます。


外部ファイルの参照

opencodeはAGENTS.md内のファイル参照を自動的に解析しませんが、2つの方法で同様の機能を実現できます:

opencode.jsonの使用

推奨されるアプローチは、opencode.jsoninstructionsフィールドを使用することです:

opencode.json

AGENTS.mdでの手動指示

AGENTS.mdで明示的な指示を提供することで、opencodeに外部ファイルを読み取るよう教えることができます。実用的な例を以下に示します:

AGENTS.md

このアプローチにより:

  • モジュール式で再利用可能なルールファイルを作成
  • シンボリックリンクやgitサブモジュールを介してプロジェクト間でルールを共有
  • AGENTS.mdを簡潔に保ちながら詳細なガイドラインを参照
  • opencodeが特定のタスクに必要な場合にのみファイルを読み込むことを保証

ヒント: モノレポや共有標準を持つプロジェクトでは、globパターン(packages/*/AGENTS.mdなど)を使用したopencode.jsonの方が手動指示より保守しやすいです。