Description
scan is an agent skill from the wshobson/agents collection that scans a codebase and writes the project documentation that other agents use to work in it. It produces two files, project-doc.md and AGENTS.md, and it is meant for bootstrapping a new agent-driven repository, or for refreshing the documentation after the code has changed a lot. The skill acts as a technical analyst. Its first step checks for two optional plugins, understand-anything, which adds deeper semantic code analysis, and context-mode, which routes large outputs through a sandbox to protect the context window. Both are optional, and when they are missing the skill falls back to standard tools such as find, grep, cat and git, summarizing large outputs inline. The result is documentation that describes this particular project rather than a generic template, so agents starting work later have accurate notes on the layout, the commands and the conventions. The skill is useful when a repository is new to agents, after a major restructuring, or when the existing project notes have drifted from the code. Generated documentation should be read by the maintainers, because an agent's summary can be wrong in places and the notes will shape the work of later agents. The skill is installed with the skills CLI from the wshobson/agents repository. Its skills.sh page showed about 4.3K installs, with Gen Agent Trust Hub and Snyk passing and Socket showing a warning at the time of the scan.…
Highlights
- Writes project-doc.md and AGENTS.md
- Bootstraps new agent-driven repositories
- Refreshes docs after large changes
- Optional deeper analysis plugins
- Fallback to find, grep, cat and git
- Installs with the skills CLI
Ratings & Reviews
No ratings yet
Be the first to rate scan.
People also visit
acquire-codebase-knowledge
The user explicitly asks to map, document, or onboard into an existing codebase
architecture-blueprint-generator
Analyzes codebases to generate comprehensive architectural documentation
create-agentsmd
Generates standardized AGENTS.md files to help AI coding agents understand
folder-structure-blueprint-generator
Analyzes project folder structures across multiple technology stacks
scan FAQ
What files does it write?
project-doc.md and AGENTS.md, which later agents use to work in the project.
When should I run it?
When bootstrapping a new agent-driven repository, or refreshing project documentation after big changes.
Does it need extra plugins?
No. The understand-anything and context-mode plugins are optional and improve results, and the skill falls back to standard tools without them.
Should I check the output?
Yes. The notes shape later agent work, so maintainers should read and correct them.
How do I install it?
Run npx skills add https://github.com/wshobson/agents --skill scan.
What security audits does it have?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Warn and Snyk Pass. A Warn or Fail is worth reading before you install.
What are the best scan alternatives?
Popular alternatives to scan include context-driven-development, acquire-codebase-knowledge and architecture-blueprint-generator. See all scan alternatives