Agent skill · writing content · nousresearch
code-wiki
Generate wiki docs + Mermaid diagrams for any codebase.
Why this skill is useful
Generates comprehensive wiki documentation and Mermaid diagrams for codebases, providing structured reference material that the AI wouldn't reliably create on its own.
What it needs
Requires git, pygount installed locally. About 8k tokens when loaded. Last updated 2026-08-07. 226,679 stars on the source repository.
What this skill does
Code Wiki Skill Generate a full wiki for any codebase — overview, architecture, per-module deep-dives, Mermaid class and sequence diagrams. Inspired by Google CodeWiki, but works on local repos, private repos, and any language. Uses only existing Hermes tools (terminal, readfile, searchfiles, writefile); no Docker, no external services, no extra dependencies. This skill produces reference documentation (what/how). It does not produce strategic narrative (why — that's a different skill). When to Use User says "document this codebase", "generate a wiki", "make architecture diagrams" Onboarding to an unfamiliar repo and wants a structured reference User points at a GitHub URL and asks for documentation Need a stable artifact (markdown + Mermaid) that renders on GitHub Do NOT use this for: Single-file or single-function documentation — just answer directly API reference for one specific endpoint — use readfile and answer inline Strategic "why does this exist" narrative — different skill, different purpose Codebases the user is actively developing in this session — just answer questions as they come Prerequisites No env vars required. git on PATH for repo SHA tracking and remote clones. Optional: pygount for language-breakdown stats (see the codebase-inspection skill). How to Run Invoke through the terminal tool from the target repo's root, then use readfile / searchfiles / writefile to produce the wiki. Default output location is ~/.hermes/wikis/<repo-name>/. Only write into the repo (docs/wiki/) when the user explicitly requests it. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills nousresearch/code-wiki