zread
OfficialUnderstand codebases through generated wiki docs.
AuthorZreadAI
Version1.0.0
Installs0
System Documentation
What problem does it solve?
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.
Core Features & Use Cases
- Read existing wiki output to onboard onto a repository quickly.
- Generate, browse, and serve documentation locally using the zread CLI.
- Use --stdio to drive zread programmatically and integrate with agents.
- Explain the roles of current, versions, and drafts in zread output.
- Reference the zread --stdio protocol for machine-to-machine interactions.
Quick Start
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.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: zread Download link: https://github.com/ZreadAI/zread-skill/archive/main.zip#zread Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.