Practical Notes
- Setup time ~15 minutes (install + scan + preview)
- Quantitative gate from README:
ruleforge audit . --min-score 80can fail CI when rules are too thin - GitHub stars + forks (verified): see Source & Thanks
Rule files only work when they reflect reality. The best pattern is to regenerate rules on every meaningful repo change (new framework, new folder layout, new CI pipeline), then review the diff like code.
Suggested routine:
- Run
ruleforge generate .(without overwrite) and review the output. - Add
ruleforge audit . --min-score 80to CI to prevent regressions in guidance quality. - Keep “forbidden actions” and “review-required operations” explicit in the rule text so agents don’t guess.
FAQ
Q: Will this overwrite my files?
A: Only if you pass --overwrite. Use preview/audit first to validate output.
Q: What formats does it generate? A: The README lists CLAUDE.md, .cursorrules, and copilot instructions as primary outputs.
Q: How do I keep rules up to date? A: Regenerate on changes and review diffs; add CI audits so guidance doesn’t drift.