Appearance
Examples
The best way to understand .principles is to see the full loop in motion.
The demo path
The canonical walkthrough lives in demo/presentation.md.
It demonstrates the project on a real codebase and shows the flow end to end:
- install the commands
- run
dot-scout - run
dot-auditon a target - inspect the findings
- fix, commit, push, and open a PR
- run
dot-primebefore the next coding session
What to look for in the walkthrough
- how
.principlesfiles are placed in different subtrees - how the audit groups findings by severity
- how the workflow supports both setup-time and day-to-day use
- how the commands stay conversational instead of becoming a dense CLI surface
Example questions to try in your own repo
- Can
dot-scoutseparate docs, infra, and application code cleanly? - Does
dot-primesurface the few rules your team most wants active? - Does
dot-auditcatch the kinds of issues your best reviewer would flag?
If the answer becomes yes often enough, the framework is earning its place.