メインコンテンツへスキップ
リポジトリルールは常に同期されます。オンにする設定はありません。リポジトリ内で Kody ルールになるのはこれらのファイルだけです。コーディングエージェント向けに書かれた指示(CLAUDE.md、AGENTS.md、.cursor/rules)は別に扱われます。コーディングエージェント向け指示 を参照してください。

使い方

リポジトリに直接カスタム Kody ルールを作成するには、特定のディレクトリに構造化されたマークダウンファイルを配置します。これにより、コードと並行してルールをバージョン管理し、チーム全体で共有できます。
リポジトリのルールファイルは そのまま(LLM 変換なしで)インポートされます。フロントマターはそのまま解析され、マークダウン本文は記述したとおりにルールの指示になり(識別子・書式・文言は保持されます)、悪い例/良い例も構造を保ってインポートされます。1 つのファイルから 1 つのルールが作成されます。テンプレートとして解析できないファイル(フロントマター、title、または本文が無いもの)はスキップされ、同期のログに記録されます。そこから何かが生成されることはありません。

同期

  • 自動検出:リポジトリルールは接続済みのすべてのリポジトリで検出・同期されます。有効化する必要はありません
  • 今すぐインポート:リポジトリの Kody Rules → Configuration シートにある Import rule files now で、デフォルトブランチ上のすべてのルールファイルを読み込みます
  • Webアプリケーション:同期されたルールは、そのリポジトリの Code review → Kody Rules ページに Auto-sync のオリジン付きで表示されます(変換が停止される前にコーディングエージェント向けファイルからインポートされたルールには、代わりに Agent file と表示されます)
  • リアルタイム更新:プルリクエストがデフォルトブランチにマージされるとルールファイルの変更が同期されます

ファイルの場所

ルールファイルを以下のいずれかのディレクトリ(リポジトリのルートまたは任意のサブディレクトリ)に配置してください:
  • .kody/rules/**/*.md
  • rules/**/*.md
  • .rules/** と docs/coding-standards/**(テンプレートに沿ったファイルのみ)

ルールテンプレート

各ルールファイルはこの正確なテンプレート構造に従う必要があります:

テンプレートフィールド

必須フィールド

厳密に必須なのは 2 つだけです:空でない title と、空でないルール本文。どちらかが欠けている ファイルは丸ごとスキップされます。

デフォルト値のあるフィールド

それ以外はすべて任意です — 省略するとデフォルトが適用されます。
severity は severity_min のエイリアスとして受け付けられます(打ち間違えやすく、意図が 明確なため)。4 つのレベル以外の値は "medium" にフォールバックし、"pull-request" 以外の scope は "file" として扱われます。

ルールの例

ファイルレベルルールの例

プルリクエストレベルルールの例

セットアップ要件

  1. ルールファイルを作成する:テンプレートに沿った .md ファイルを .kody/rules/** または rules/** に配置します。.rules/** と docs/coding-standards/** にあるテンプレートに沿ったファイルもインポートされます。
  2. マージする:ルールファイルは、それを追加・変更・リネーム・削除するプルリクエストがデフォルトブランチにマージされたときに同期されます。ファイルを削除するとそのルールも削除されます。
  3. 既存のファイル:デフォルトブランチにすでにあるルールファイルをインポートするには、リポジトリの Kody Rules → Configuration シートで Import rule files now を使います。
新しいルールは有効な状態で追加されます。Kody knowledge approval がオンの場合は Pending review に入ります。
ルールファイルをリポジトリに残したまま同期しないようにするには、ファイル内のどこかに @kody-ignore を追加します。既存のルールは次回の同期で削除されます。

同期とルール評価の確認(セルフホスト)

セルフホストのデプロイでは、API のログに grep しやすいマーカーが出力されます:
  • [kody-rules-sync] — 実行ごとの同期サマリー:どのファイルがインポート・スキップ(理由付き)・削除されたか。
  • [kody-rules-eval] — レビュー中のファイル単位の評価トレース:レビュー対象ファイルごとに、どのルール(uuid + タイトル)がプロンプトに選ばれたか。
UI 上では有効なのに、期待するファイルの [kody-rules-eval] に一度も現れないルールがある場合は、その Path グロブを確認してください — ルールはパスに一致するファイルでしか実行されません。

ルールの上限

クラウドの Free プランの組織(またはサブスクリプションがキャンセル済み・期限切れの組織)と、有効なライセンスなしで稼働しているセルフホストインスタンス(Community Edition)は、1 回のレビューで最大 10 個の有効なルール(古い順)までしか評価しません。上限を超えたルールは Locked としてリストに残り、すべての PR でスキップされます。Code review → Kody Rules のバナーに、スキップされているルールの数が表示されます。有料のクラウドプランとライセンス済みのセルフホストにはこの上限はありません。11 個目以降のルールが発火しない場合は、この上限が原因です。