skills.rest
ZreadAIZreadAIOfficial·1 Agent Skills Included

zread-skill

Generate and read wiki documentation for unfamiliar codebases

Generates wiki-style documentation for any code repository and reads it directly from disk. Eliminates the need to crawl source files one by one when onboarding onto an unfamiliar codebase. Guides safe doc generation, draft recovery, and local browsing through a machine-readable command protocol.
157|10
↗
npx skills add ZreadAI/zread-skill --all -g -y

All Skills in This Repository (1)

Pure Emerald Level Indicators
📦 In Repo
ZreadAIZreadAI

zread

Generate and consume wiki-style knowledge bases for code repositories via the zread CLI.

Official
Intermediate

Frequently Asked Questions

FAQPage Schema
How to install zread-skill?▼

Run `npx skills add ZreadAI/zread-skill --all -g -y` in your terminal to install this skill globally. You also need the zread CLI itself, available via npm or Homebrew.

How to understand an unfamiliar codebase quickly?▼

This skill reads zread-generated wiki pages from the .zread/wiki folder, giving your agent a structured project overview instead of re-reading every source file.

How does zread generate repository documentation?▼

It runs `zread generate` to build a wiki with a page index and markdown files under ./.zread/wiki/, after confirming with you since generation consumes LLM tokens.

Does zread-skill work with Claude Code and Codex?▼

Yes. It follows the universal SKILL.md standard and works in Claude Code, OpenClaw, Codex, and other compatible agents.

Can scripts drive zread programmatically?▼

Yes. Every command supports a --stdio mode that uses a JSON-line protocol, so agents and scripts get parseable output instead of an interactive interface.

Related Repositories in Software Engineering

View All in Software Engineering→
openclawopenclaw
388.4k

openclaw

Run a personal AI assistant across your devices and chat apps

Official📦 120 Skills
obraobra
280.0k

superpowers

Gives coding agents a disciplined workflow from idea to merged code

Community📦 15 Skills
facebookfacebook
248.4k

react

AI agent skills for building, testing, and porting React core

Official📦 14 Skills