repo-surveyor
Skill1 starsChanged 4 months agoApache-2.0View on GitHub
Review a repository without editing code or running tests, then open an HTML report with ranked, evidence-backed maintainability findings and before-and-after Mermaid diagrams. Use when asked to scan, review, audit, simplify, optimize, or improve a codebase's architecture without implementing changes.
In this repository19 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-aeoSkill
- agent-memorySkill
- beanquerySkill
- ci-repairbaySkill
- delegated-developmentSkill
- ghSkill
- issue-blueprintSkill
- issue-workbenchSkill
- minifluxSkill
- og-imageSkill
- opSkill
- pencil-to-figma-migrationSkill
- pr-comment-sweepSkill
- pr-launchpadSkill
- review-checkpointSkill
- review-repairbaySkill
- shipyardSkill
- skill-optimizerSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 20
Read repository instructions, branch state, README, manifests, and relevant architecture decisions or domain terms.
- Very specific: line 30
Stop after the main hotspots and at most five verified Current candidates.
- Very specific: line 44
Default invocation stops after the report.
≈ “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
repo-surveyor
Review only. Do not edit the repository or run tests, builds, linters, formatters, type checks, generators, installers, or application commands. The temporary HTML report is the only write besides ignored agent-memory artifacts.
Memory
Direct invocation owns $agent-memory; nested invocation defers it to the
caller. Capture only established durable rules, constraints, or reusable root
causes—not findings, scores, issue candidates, or routine observations.
Survey
- Read repository instructions, branch state, README, manifests, and relevant
architecture decisions or domain terms. Inventory with
rg --files, excluding generated, vendor, dependency, build, cache, binary, and lock files; preserve and account for dirty user changes. - Make one breadth pass over source, tests, config, scripts, entry points, boundaries, dependencies, state ownership, and test seams. Explicitly assess DRY, SOLID, test strategy, and architecture without mechanical scoring.
- Prove candidates with focused reads. Reject style-only, speculative,
cleanup-only, or decision-conflicting ideas; label evidence
Current,Solved, orUnclearand name the missing check forUnclear. - Stop after the main hotspots and at most five verified
Currentcandidates. Rank by impact, architectural leverage, confidence, and change size; useP0only for active correctness, security, or data-integrity risk,P1for high-leverage maintainability, andP2for worthwhile lower urgency.
Each ranked candidate needs rank, title, priority, Current classification,
exact files, 1–3 evidence items, a one-sentence problem and smallest credible
proposal, up to three benefits, and paired
flowchart TB Mermaid diagrams titled before/after with 2–5 evidence-backed
module, interface, service, or state-boundary nodes. Do not force findings or
recommend abstractions without demonstrated complexity reduction.
Optional Issue Planning
Default invocation stops after the report. Only an issue-planning request made
when invoking this skill permits issue deduplication and an issue-blueprint
handoff. Query plausible open issues with gh; classify candidates as new,
duplicate-of #N, overlaps #N, or solved-by #N. Hand off the existing
report path, ranked evidence-backed candidates, duplicate classifications,
dropped reasons, and material constraints. Do not construct issue-plan JSON or
a new planning artifact: Issue Blueprint alone owns issue slicing,
dependencies, validation, graph JSON, approval, and publication.
Report
Copy assets/report.html to
${TMPDIR:-/tmp}/repository-survey-<UTC timestamp>.html. Replace only content
between REPORT_CONTENT_START and REPORT_CONTENT_END; escape repository text
and keep JavaScript limited to Mermaid rendering. Include a header, conclusion,
explicit DRY/SOLID/test-strategy/architecture coverage, and one
<article id="candidate-<rank>"> per finding with the required evidence and
.visual.before/.visual.after Mermaid blocks. With no finding, render one
unranked paired overview showing no recommended structural change. Include
optional planning output only when authorized. Verify visible static text,
paths, diagrams, and the absolute output path; open the report and return its
path plus material caveats.
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.

