Agent skill

Zread

Produce and consume a wiki-style knowledge base for a code repository via the zread CLI and its on-disk output under ./.zread/wiki/.

No licenceAuto-check passedKnowledge Management

Install Zread

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .claude/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .agents/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .cursor/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .gemini/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .github/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add ZreadAI/zread-skill --skill zread -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install ZreadAI/zread-skill zread --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "zread" agent skill from https://github.com/ZreadAI/zread-skill/tree/main into .opencode/skills/zread/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "zread", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: zread
GitHub stars: 177
Token cost: ~1.4k tokens
SKILL.md length: 590 words
Files: 3 (incl. references)
Skills in repo: 1
Repo updated: Apr 9, 2026
First seen: Oct 7, 2026
Licence: None found

At a glance

Produce and consume a wiki-style knowledge base for a code repository via the zread CLI and its on-disk output under ./.zread/wiki/.

Works in 4 steps: User wants to read existing wiki content? → User wants to (re)generate docs? → User wants to view docs in a browser? → …
The user wants to understand
SKILL.md covers On-disk layout (read these…, Commands, Decision tree for an AI agent and Non-interactive invocation rules, plus 2 more sections
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Zread is an agent skill from ZreadAI/zread-skill. Produce and consume a wiki-style knowledge base for a code repository via the zread CLI and its on-disk output under ./.zread/wiki/. Use this skill whenever the user wants to understand, onboard onto, explore, summarize, map, or get an overview of an unfamiliar codebase; asks for architecture docs, a project wiki, a repo walkthrough, module/package explanations, or "what does this repo do"; wants to generate, regenerate, resume, browse, or serve code documentation locally; or mentions zread / zread.ai directly…

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `README.md` and `references/stdio-protocol.md`).

It sits in Knowledge Management, covering Technical documentation and Knowledge bases.

When your agent uses it

The user wants to understand
Get an overview of an unfamiliar codebase
Asks for architecture docs
A repo walkthrough

Example prompts

“what does this repo do”
“/zread”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

User wants to read existing wiki content?
User wants to (re)generate docs?
User wants to view docs in a browser?
User wants to script zread / consume output programmatically?

What it can do on your machine

Read from SKILL.md and the folder at commit 9b96f04. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
- zread.ai
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Zread loads about 1.4k tokens when it runs, and up to ~4.7k if it reads all its reference files. Until then it costs about 214 tokens; SKILL.md has 590 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~214
When it runs · the whole SKILL.md, loaded when a task matches: ~1.4k
With references · SKILL.md plus every file in references/, read only if the agent opens them: ~4.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Without a licence we can't republish the file, so here is its outline and opening line. It has 590 words (~1,373 tokens).

“zread is a CLI that generates wiki documentation from code in the current workspace using an LLM. Output lives under ./.zread/wiki/ in the workspace; public repos can also be viewed at https://zread.ai.”

— opening of SKILL.md by ZreadAI

name: zread

Read the full SKILL.md on GitHub

Files

SKILL.md and 2 other files (references) in the repository root of ZreadAI/zread-skill.

SKILL.md
README.md
references/stdio-protocol.md

Open the folder on GitHubat commit 9b96f04

Compare with similar skills

Zread next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Zread compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Zread this skillZreadAI/zread-skill	177	—	~1.4k	Automated safety check: Pass	None	6 mo ago
LLM WikiCharlesHoskinson/sevenlayer	116	—	~1.5k	Automated safety check: Pass	Custom licence	1 mo ago
New LoopAI-Builder-Club/skills	1.3k	—	~1.2k	Automated safety check: Notes	None	22 days ago
Docs Knowledge Baseagglayer/agglayer	117	—	~344	Automated safety check: Pass	Apache-2.0	yesterday
Tech Distilleryaofeino1/tech-distiller	144	—	~1.2k	Automated safety check: Pass	None	6 mo ago
Share Session Learnings with the TeamTencent/teamai-cli	5.1k	—	~727	Automated safety check: Pass	Custom licence	yesterday

Similar skills

LLM Wiki
CharlesHoskinson/sevenlayer
Builds and maintains a persistent, interlinked Obsidian-compatible markdown knowledge wiki in a git repo via three operations — ingest a source into linked pages, answer a question from the…
116 GitHub stars~1.5k tokensUpdated 1 mo ago
Knowledge ManagementAuto-check passed
New Loop
AI-Builder-Club/skills
Spin up a new loop (domain) in a file-based knowledge base — bootstrap the substrate if it's missing, gather the loop's charter, scaffold domains/<loop/README.md, then do ONE real test run and…
1.3k GitHub stars~1.2k tokensUpdated 22 days ago
Knowledge ManagementAuto-check: notes
Docs Knowledge Base
agglayer/agglayer
Create or update docs/knowledge-base/ chapters in mdbook format for human-first technical documentation.
117 GitHub stars~344 tokensUpdated yesterday
Knowledge ManagementAuto-check passed
Tech Distiller
yaofeino1/tech-distiller
Collects technical documents from URLs, files, wikis or APIs, filters them by role or technical direction, and writes a structured report on architecture, algorithms and design decisions.
144 GitHub stars~1.2k tokensUpdated 6 mo ago
Knowledge ManagementAuto-check passed
Share Session Learnings with the Team
Tencent/teamai-cli
Summarizes what an AI coding session solved or discovered and publishes it to the team knowledge base with the teamai contribute command.
5.1k GitHub stars~727 tokensUpdated yesterday
Knowledge ManagementAuto-check passed
Capture Conversation
outline/outline
Save the current conversation, a decision, or a set of notes as a document in an Outline collection; use when the user wants to keep what was discussed in their knowledge base.
41k GitHub stars~474 tokensUpdated today
Knowledge ManagementAuto-check passed

Questions about Zread

What does Zread do?

Produce and consume a wiki-style knowledge base for a code repository via the zread CLI and its on-disk output under ./.zread/wiki/. Zread is an agent skill from ZreadAI/zread-skill.zread/wiki/.

When should I use Zread?

Zread fits situations like: the user wants to understand; get an overview of an unfamiliar codebase; asks for architecture docs; A repo walkthrough.

How do I install Zread in Claude Code?

Run `npx skills add ZreadAI/zread-skill --skill zread -a claude-code`. Or copy the skill folder (the ZreadAI/zread-skill repository) into .claude/skills/zread in your project. Claude Code loads it when a task matches its description.

How do I install Zread in Codex?

Run `npx skills add ZreadAI/zread-skill --skill zread -a codex`. Or copy the skill folder (the ZreadAI/zread-skill repository) into .agents/skills/zread in your project. Codex loads it when a task matches its description.

Can I use Zread in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ZreadAI/zread-skill --skill zread -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/zread, .gemini/skills/zread, .github/skills/zread and .opencode/skills/zread in your project.

What does Zread need to run?

SKILL.md names no scripts, command-line tools or credentials: Zread is instructions for the agent only.

Does Zread access the network?

SKILL.md names 1 domain. As links in the text: zread.ai. This is read from the text; nothing was executed.

Is Zread safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Zread use?

No licence was found for Zread or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Zread use?

About 1.4k tokens (SKILL.md is roughly 5.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 3.4k tokens, read only when the agent opens those files.

What are the alternatives to Zread?

Skills that share tags, products or a category with Zread: LLM Wiki (CharlesHoskinson/sevenlayer, 116 stars), New Loop (AI-Builder-Club/skills, 1.3k stars), Docs Knowledge Base (agglayer/agglayer, 117 stars) and Tech Distiller (yaofeino1/tech-distiller, 144 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Zread?

ZreadAI (a GitHub organization) maintains it in ZreadAI/zread-skill, which has 177 GitHub stars. The repository was last updated on April 9, 2026.

Source: ZreadAI/zread-skill on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Zread

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Files

Compare with similar skills

Similar skills

LLM Wiki

New Loop

Docs Knowledge Base

Tech Distiller

Share Session Learnings with the Team

Capture Conversation

Related

Questions about Zread