{
  "markdown": "# Zread Skill\n\nThis repository contains a skill for `zread`, a CLI that generates wiki-style\ndocumentation for code repositories.\n\nThe skill is meant for one job: help an agent understand an unfamiliar codebase\nthrough `zread` output instead of re-reading the entire repository file by file.\n\n## Installation\n\n### 1. Install the zread CLI\n\nInstall `zread` first. There are two supported installation methods:\n\n```bash\nnpm install -g zread_cli\n```\n\nor\n\n```bash\nbrew tap ZreadAI/homebrew-tap\nbrew install zread\n```\n\nThen verify the installation:\n\n```bash\nzread version\n```\n\n### 2. Install this skill\n\nAsk your AI agent to install the skill from GitHub:\n\n```text\ninstall this skill https://github.com/ZreadAI/zread-skill\n```\n\nIf you prefer to install it manually, copy this directory into your local\nskills directory:\n\n| Agent       | Skills directory        |\n| ----------- | ----------------------- |\n| Claude Code | `~/.claude/skills/`   |\n| OpenClaw    | `~/.openclaw/skills/` |\n| Codex       | `~/.agents/skills/`   |\n\nExample:\n\n```bash\ncp -R zread ~/.claude/skills/zread\n```\n\nYour final layout should look like this:\n\n```text\n<skills-dir>/zread/\n  SKILL.md\n  README.md\n  references/\n    stdio-protocol.md\n```\n\nOnce the folder is in place, an agent that supports `SKILL.md`-based skills can\nload and use it.\n\n## Features\n\n- Read existing `./.zread/wiki/` output instead of crawling source files again\n- Guide an agent to run `zread generate` safely when documentation does not\n  exist yet\n- Use `--stdio` as the default mode for agent automation, instead of parsing\n  the interactive TUI\n- Explain the role of `current`, `versions`, and `drafts` in zread output\n- Include a reference for the `zread --stdio` JSON-line protocol\n\n## When To Use\n\nUse this skill when you want to:\n\n- understand an unfamiliar repository quickly\n- read an existing zread-generated wiki\n- generate a repository overview or project wiki\n- serve docs locally with `zread browse`\n- drive `zread` programmatically from a script or agent\n\n## How It Works\n\nThe skill follows a simple workflow:\n\n1. If `./.zread/wiki/current` exists, read the generated wiki files directly.\n2. If no wiki exists, run `zread generate` only when the user wants docs to be\n   generated.\n3. Before generation, confirm with the user because generation consumes LLM\n   tokens and writes under `./.zread/`.\n4. In automated workflows, use `--stdio`.\n\n## Repository Layout\n\n- `SKILL.md`: the skill definition, trigger conditions, and operating rules\n- `references/stdio-protocol.md`: the `zread --stdio` machine protocol\n- `appmap.log`: local artifact, not part of the skill itself\n\n## zread Output\n\nAfter a successful generation, zread typically writes:\n\n- `./.zread/wiki/current`: the active wiki version id\n- `./.zread/wiki/versions/<id>/wiki.json`: the generated page index\n- `./.zread/wiki/versions/<id>/<file>`: the actual markdown pages\n- `./.zread/wiki/drafts/`: unfinished generation state\n\nIf you need to integrate with `zread` programmatically, see\n[references/stdio-protocol.md](./references/stdio-protocol.md).\n",
  "bytes": 3070,
  "sha": "0f7960af5f933d66a68d8d0d15fdf1a165f897476e9969324032e399753c4259",
  "repo_slug": "zreadai/zread-skill",
  "fonte": "repo",
  "truncated": false,
  "api": "https://api.agentalog.com/api/listings/skl_zreadai_zread_skill_zread_e0d20a10/readme"
}