crux-doctor
Skill4 starsChanged 21 days agoMITView on GitHub
Give a project a checkup: verify that its documentation repo meets the standard (contract, mandatory structure, declared repos against those present, profile rules, ADR status, markdown links, orphan documents and skill format) and leave it conformant. Use after migrating or reorganizing documentation, when registering a new repo, when returning to a project you haven't touched in a while, or when you want to check whether something has drifted out of alignment.
In this repository46 other files it gives its agents.
- AGENTS.mdAGENTS.md
- add-repo-to-docsSkill
- adrSkill
- auth-bypass-localSkill
- before-afterSkill
- bug-huntSkill
- carry-envSkill
- code-healthSkill
- crux-initSkill
- css-to-componentsSkill
- deploy-fallbackSkill
- deploy-watchSkill
- device-loopSkill
- drive-browserSkill
- e2eSkill
- end-sessionSkill
- eval-fixturesSkill
- explain-planSkill
- flowSkill
- grillSkill
- merge-conflictsSkill
- motion-videoSkill
- oauth-reauthorizeSkill
- prod-signalsSkill
- promote-to-docsSkill
- prose-checkSkill
- read-documentSkill
- render-loopSkill
- repo-mapSkill
- review-prSkill
- root-causeSkill
- runbookSkill
- security-auditSkill
- share-localSkill
- shipSkill
- skill-auditSkill
- skill-creatorSkill
- teachSkill
- ui-behaviourSkill
- ui-tellsSkill
- visual-diffSkill
- visual-testSkill
- wizardSkill
- workspaceSkill
- write-testsSkill
- x-postsSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Before closing a work session with documentation changes.
- Distinctive: line 14
After moving, renaming or deleting documentation files.
- Distinctive: line 15
When returning to a project you haven't touched in months.
- Distinctive: line 16
After updating the kernel, to see which projects were left out of date.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
crux-doctor
Checks a docs repo's conformance with the standard. The standard is of little use if you just trust that it is being followed.
When to use
- Before closing a work session with documentation changes.
- After moving, renaming or deleting documentation files.
- When returning to a project you haven't touched in months.
- After updating the kernel, to see which projects were left out of date.
Usage
crux doctor # on the project in the current directory
crux doctor <dir> # on another oneIt exits with code 1 if there are errors. Warnings don't block.
What it checks
- The contract. That
crux.jsonexists, that it has the mandatory fields, that the declared profile exists and which kernel version was used. - The mandatory structure. The files in the standard's floor, and that the Claude pointer is a link to the canonical one and not a copy that diverges.
- Declared repos against reality. Repos without a documentation folder, undeclared folders, declared repos that aren't on disk.
- The profile rules. In an own-code project, that every repo has its pointers. In a client one, that nobody has written to the foreign repo: that is an error, not a warning.
- Markdown links. That all of them resolve inside the docs repo.
- The project's skills. Frontmatter present and name consistent with the directory.
How to interpret the result
Errors: they break the standard and have to be fixed: missing contract, broken links, writing to foreign code, declared repo without documentation.
Warnings: the project is still valid, but something is drifting out of alignment: outdated kernel version, undeclared folder, declared repo not yet cloned. They deserve a decision, not necessarily an immediate action.
Typical fixes
| Symptom | Fix |
crux.json missing | crux adopt |
| Outdated version | crux upgrade |
| Repo without pointer | crux link |
Undeclared folder in repos/ | /add-repo-to-docs, or delete it if surplus |
| Link to a file in another repo | convert it to text in backticks |
A markdown link pointing outside the docs repo is not fixed by correcting the path: it is converted to plain text. The standard forbids them because they break with any reorganization and end up lying, and there is no build that validates them.
Related
/end-session: the closing ritual, which runs this as one of its steps/crux-init: create a new project under the standard
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

