Repository Rules (.lrc/)
lrc config manages the .lrc/ directory, which holds repository-specific rules that LiveReview uses when reviewing your commits.
lrc configNAME:
lrc config - Manage .lrc/ repository rules configuration
USAGE:
lrc config [command options]
COMMANDS:
init Scaffold the .lrc/ directory structure
check Validate .lrc/ rules and structure (offline)
preview Show the rules bundle LiveReview will use (offline)
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show helpScaffold .lrc/
lrc config initCreates:
.lrc/README.md
.lrc/ignore
.lrc/rules/INSTRUCTIONS.md
.lrc/rules/design.md
.lrc/rules/security.md
.lrc/rules/style.md.lrc/ignore— paths to exclude from review, similar to.gitignore..lrc/rules/— one file per rule category. Add or remove.mdfiles here to organize rules however fits your team.
Write Rules in INSTRUCTIONS.md
.lrc/rules/INSTRUCTIONS.md sets the priorities and escalation policy git-lrc applies during review. Example:
Critical areas: auth, payments, access control, migrations
Always-review changes: permission checks, input validation, logging statements
Escalate when: behavior changes without explicit intent notes
Block until fixed: credential leakage, sensitive data loggingUse the other rule files (design.md, security.md, style.md, or your own) to capture more detailed, category-specific guidance referenced by INSTRUCTIONS.md.
Validate and Preview
lrc config checkValidates .lrc/ structure and rule files offline, without contacting LiveReview.
lrc config previewShows the exact rules bundle LiveReview will use for reviews, so you can confirm your rules are picked up correctly before committing.
Repository Rules vs. Custom Prompts
Repository Rules are per-repo — write down whatever your team needs, without affecting any other repo. Custom Prompts are org-wide instead, applying to every repo LiveReview reviews. Most teams should start with Repository Rules, and only use Custom Prompts for the handful of standards that are genuinely universal across the org.
Related
- Set Review Rules
- Integrations
- Customize LiveReview to Your Team’s Best Practices (org-wide Custom Prompts)