Repository Rules use the same auto-sync mechanism as IDE rule file detection. Enable “Auto-sync rules from repo” in settings to activate both features. See Rules File Detection for setup.
How to Use
You can create custom Kody Rules directly in your repository by placing structured markdown files in specific directories. This allows you to version control your rules alongside your code and share them across your team.Synchronization
- Automatic Detection: Repository rules are automatically detected and synchronized when enabled
- Manual Sync: Add
@kody-sync
to any rule file to sync it individually (works even with auto-sync disabled) - Web Application: Synchronized rules appear in your Kodus web application dashboard
- Real-time Updates: Changes to rule files are synced when Pull Requests are closed
File Location
Place your rule files in one of these directories:.kody/rules/**/*.md
rules/**/*.md
Rule Template
Each rule file must follow this exact template structure:Template Fields
Required Fields
Field | Description | Values |
---|---|---|
title | Rule name displayed in the interface | Any descriptive string |
scope | Rule analysis scope | "file" or "pull_request" |
path | File paths where rule applies | Array of glob patterns |
severity_min | Minimum severity level | "low" , "medium" , "high" , "critical" |
Example Rules
File-Level Rule Example
Pull Request-Level Rule Example
Setup Requirements
To use Repository Rules, you have two options:Option 1: Enable Auto-Sync (Recommended)
- Enable Rules File Detection: Toggle “Auto-sync rules from repo” in settings
- Create rule files: Place
.md
files in.kody/rules/**
orrules/**
directories - Automatic sync: All rule files sync when PRs are closed
Option 2: Manual Sync (Selective)
- Create rule files: Place
.md
files in.kody/rules/**
orrules/**
directories - Add sync marker: Include
@kody-sync
anywhere in the rule file - Commit changes: Only marked files will sync (auto-sync toggle stays off)
Repository Rules use the same synchronization mechanism as Rules File Detection. Use manual sync (
@kody-sync
) to selectively sync specific rules without enabling automatic synchronization.