Skip to content
Development
Skill

/doctor

Run a read-only hygiene + documentation audit on the current repo. TRIGGER when the user says "is this repo healthy", "check hygiene", "audit this repo" (when they mean inspect, not remediate), "what's drifted", "run doctor", "run a health check", "audit docs", "check for doc

From plugin
nyann
741 skills41 commands3 hooks

Claude Code

$ npx -y skills add thettwe/nyann --skill doctor --agent claude-code

SKILL.md

doctor.SKILL.md
name: doctor
description: >
  Run a read-only hygiene + documentation audit on the current repo.
  TRIGGER when the user says "is this repo healthy", "check hygiene",
  "audit this repo" (when they mean inspect, not remediate), "what's
  drifted", "run doctor", "run a health check", "audit docs", "check
  for doc drift", "what's broken in this project", "are the hooks
  still installed", "/nyann:doctor".
  Do NOT trigger on "fix this repo" / "remediate" / "bring it into
  compliance" — those are retrofit (audit + fix). doctor
  reports, never writes. Do NOT trigger on "what does this repo do"
  (that's a docs pointer, not a hygiene audit).

doctor

Read-only audit. Never mutates the filesystem. Wraps `bin/doctor.sh`, which internally runs `bin/retrofit.sh --report-only`.

1. Resolve the profile

`doctor.sh` requires `--profile <name>`. The skill's job is to pick the right one without pestering the user:

1. Look for a `.nyann/profile` or equivalent profile hint in the repo. 2. If the repo's CLAUDE.md declares an active profile, use that. 3. If neither exists, ask the user which profile to audit against (`default`, `nextjs-prototype`, `python-cli`, or any user/team profile they've installed). Don't silently pick `default` — the audit is only meaningful against an intended baseline.

2. Invoke

bin/doctor.sh --target <cwd> --profile <name> [--json] [--scope <csv>]

`--profile` takes a **bare profile name** (e.g. `python-cli`, `nextjs-prototype`), not a filesystem path. The script resolves the name to the profile JSON internally.

Pass `--json` when the user says "machine-readable", "as JSON", "pipe this", or similar — otherwise emit the human-readable report.

Pass `--scope <csv>` when the user wants to inspect only a subset of the audit — e.g. "just check my docs", "are my hooks healthy". Accepts any of `docs`, `hooks`, `branching`, `gitignore`, `editorconfig`, `github`, `history`, `all`, comma-separated. When narrower than `all`, the rendered output gains a `Scope: <csv>` line and `--persist` is auto-disabled (a partial-scope health score would corrupt the trend series in `memory/health.json`).

3. Interpret the exit code

| Code | Meaning | What to tell the user | |---|---|---| | 0 | clean | "No drift. Hygiene and docs look healthy." | | 4 | warnings only | "Not failing, but some things have drifted. Here's the list." Offer to remediate via `retrofit`. | | 5 | critical | "Missing required files or broken internal links. Run `retrofit` to fix." |

4. Sections in the report

The output has several blocks. When the user asks "what does each section mean?", explain in terms of the repo, not nyann internals:

  • **MISSING:** files the profile expects but the repo lacks (e.g. no

`.husky/pre-commit` when the profile declares husky hooks).

  • **MISCONFIGURED:** files present but content doesn't match (e.g. a

`.husky/pre-commit` exists but doesn't actually run the expected linter).

  • **NON-COMPLIANT HISTORY:** last N commit subjects that don't match

Conventional Commits. Informational — nyann never rewrites history.

  • **DOCUMENTATION:** CLAUDE.md size vs budget, internal link resolution,

MCP link reachability (when MCP connectors are available), orphan files under `docs/` / `memory/`, and misplaced docs (files at non-canonical paths that could be reorganized via retrofit).

  • **GITHUB PROTECTION:** branch protection per strategy, tag-protection

rulesets (when `.github.tag_protection_pattern` is declared in the profile), CODEOWNERS-required gate (when a CODEOWNERS file exists or `.github.require_code_owner_reviews=true`), and repo-security settings (Dependabot, secret scanning, push protection, code scanning). Soft-skips when `gh` is missing or unauthenticated. Driven by `bin/gh-integration.sh --check` under the hood. Critical drift here bumps the exit code to 5; warn drift bumps it to 4.

  • **DOC STALENESS:** doc files under `docs/` whose correlated source

paths have changed substantially since the doc itself was last touched. Heuristic-based (`bin/docs-staleness.sh`); thresholds configurable via the profile (`documentation.staleness_threshold_*`). Informational — never affects exit code.

  • **PUBLIC-DOC DRIFT:** README/CONTRIBUTING/SECURITY/docs/*.md scanned

for version-ref drift (semver older than latest tag), broken markdown link targets, missing `npm run` / `make` script references, and count-claim drift (opt-in per profile). Driven by `bin/docs-drift-scan.sh`. Critical/high findings escalate the exit code (mirrors GitHub protection); medium/low are advisory.

  • **IAC DRIFT:** IaC source (`*.tf`, `Chart.yaml`, `Pulumi*.yaml`,

`*.tfvars`, Ansible vars) scanned for committed secrets (critical), unpinned module refs / providers / deps (high), missing lockfiles and Helm `appVersion` lag (medium). Filesystem + git only — no `terraform plan`, no cloud calls. Driven by `bin/iac-drift-scan.sh`, gated per profile via `iac.drift_check.{enabled, unpinned_refs, missing_lockfile, secrets_in_vars, version_lag}`. Critical/high findings escalate the exit code (mirrors public-doc drift); medium/low are advisory. Silent on non-infra repos. Like public-doc drift, this is score-isolated — it shapes the exit code but not the numeric health score.

The protection block respects nyann's gh-best-effort invariant — it never prompts for credentials and never blocks the audit. When `gh` isn't reachable, the section reports `skipped` and contributes no drift to the exit code.

5. Surface health trend (when available)

After showing the audit report, check whether `memory/health.json` exists in the target repo. If it does:

1. Run `bin/health-trend.sh --target <cwd> --last 10`. 2. Show the sparkline and summary: "Health trend: ▃▄▅▆▇ — 72→85 over last 10 checks (↑ improving)." 3. If any `category_deltas` show worsening (delta < 0 in the breakdown), call them out: "⚠ `missing` got worse (−3 over the window)." 4. If

Read more
@thettwe
Ships withnyann

ငြမ်း is Burmese for scaffolding. Nyann is the Claude Code plugin that picks expert git defaults for your stack — branching, working hooks (Husky / pre-commit.com / lefthook), commits, releases, CI, docs — then keeps the repo on those rails through every PR

Stars on GitHub

Momentum

stars in total
7
Star history of thettwe/nyann on GitHub, a chart by star-history.com

Other skills on nyann.

add-team-source

add-team-source

Register a git URL as a team-profile source so nyann can periodically sync and expose its profiles under a namespace. TRIGGER…

@thettwe@thettweInstall Skill
bootstrap-project

bootstrap-project

Bootstrap a fresh or existing repo with nyann. TRIGGER when the user says "set up this project", "initialize git workflow",…

@thettwe@thettweInstall Skill
check-prereqs

check-prereqs

Survey the machine and report which nyann features are usable right now. TRIGGER when the user says "is my machine ready for…

@thettwe@thettweInstall Skill
cleanup-branches

cleanup-branches

Prune local branches whose work is already merged into the base. TRIGGER when the user says "clean up branches", "delete merged…

@thettwe@thettweInstall Skill
commit

commit

Generate a Conventional Commits message from the staged diff and create the commit after user confirmation. TRIGGER when the user…

@thettwe@thettweInstall Skill
diagnose

diagnose

Bundle a redacted, support-grade snapshot of the current nyann state for inclusion in a bug report or support request. Combines…

@thettwe@thettweInstall Skill

More skills from other plugins.

brainstorming
Auto-invoked

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or…

@obra@obraInstall Skill
ask-matt

ask-matt

Ask which skill or flow fits your situation. A router over the skills in this repo.

skills2w309k
@mattpocock@mattpocockInstall Skill
accessibility
Auto-invoked

accessibility

Design, implement, and audit accessible UI to WCAG 2.2 Level AA across Web, iOS, and Android — semantic ARIA roles and labels,…

ecc2w293k
@affaan-m@affaan-mInstall Skill
compiler-commit

compiler-commit

Use when you want to verify compiler changes and commit with the correct convention. Runs tests, lint, and format, then commits…

react5d252k
@facebook@facebookInstall Skill

Questions about doctor.

Which coding agents can use doctor?
doctor installs in Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, OpenCode and Windsurf with the skills CLI, using each agent's flag shown on this page. Flowy's auto-invocation, which fires a skill when your prompt matches, runs in Claude Code only.