Generate and consume wiki-style knowledge bases for code repositories via the zread CLI.
npx skills add https://github.com/ZreadAI/zread-skill --skill zread
Please help me install this Agent Skill. Skill: zread Source: https://github.com/ZreadAI/zread-skill/tree/main Command: npx skills add https://github.com/ZreadAI/zread-skill --skill zread
zread provides a streamlined workflow to understand unfamiliar codebases by generating and consuming a wiki-style knowledge base from on-disk output. It guides readers to leverage existing wiki content when available and to generate new documentation only when needed, avoiding exhaustive per-file review.
Install the zread CLI, then install this skill from GitHub and load it into your agent to start generating and reading wiki-style docs for a repository.
High-intent search queries and answers about installing and using this skill.
Generate wiki-style documentation for an unfamiliar codebase by installing the zread CLI and running it against your repository to produce on-disk wiki output. It creates a browsable knowledge base so you can understand architecture without reading every file.
The best way to onboard to a new code repository without reading every file is to consume existing wiki-style knowledge base output. zread guides readers to leverage existing wiki content first, generating new documentation only when needed.
Yes, you can use the zread CLI programmatically with agents via the stdio protocol. This enables safe, machine-to-machine interactions to drive codebase exploration, mapping, and summarization tasks directly.
The current, versions, and drafts structure in codebase wiki output organizes documentation states within the on-disk output. This structure helps manage exploration by separating active docs from historical versions and new draft summaries.
You should avoid using generated wiki docs for codebase exploration when you need granular, line-level implementation details rather than high-level repo overviews. The wiki output targets architecture summaries and onboarding, not exhaustive per-file code review.
davron-designScaffold a wiki vault with raw, wiki, and output directories.
davpatel605-beepGenerate structured wiki documentation and Mermaid architecture diagrams from source code.
tianxiao1430-jpgAnalyze GitHub repositories with Zread MCP for structural audits and architecture reviews.
PaneriVatsalGenerate developer-facing documentation from repository structure and source files.
