~/my-project

$zread
───Catalog
Catalog[done]
───Pages 19/27
— Overview[done]
— Project Structure[done]
— Dev Environment[done]
— Core Modules[done]
— Data Flow[done]
— Team Conventions[done]
— Deployment[done]
⠋ Scanning workspace[processing]
⠋ Understanding modules[processing]
⠋ Generating pages[processing]
○ Building navigation[waiting]
○ Starting local preview[waiting]

···

Use CLI with Skill:

github.com/ZreadAI/zread-skill

Zread CLI

1. What is the CLI for?

Zread CLI is built for local repository workflows and helps developers generate project docs directly from a local directory.

It is useful when you need to:

  • understand code structure quickly
  • create baseline project docs
  • provide a reading entry for team onboarding
  • give AI coding tools clearer project context

2. Install

You can install it with npm or Homebrew:

npm install -g zread_cli
brew tap ZreadAI/homebrew-tap
brew install zread

3. Quick Start

If you want to use Zread CLI more easily in AI agents such as Claude Code, Codex, and OpenClaw, see the official skill setup guide.

You can also ask your AI to install the skill from GitHub:

install this skill https://github.com/ZreadAI/zread-skill

Recommended flow:

cd repo
zread

When you want to use Zread, just enter the repo and run zread. The CLI will guide the next step based on the current state, such as login, doc generation, or opening docs that already exist.

If docs already exist and you want to open them in the browser, run:

zread browse

localhost:3000

my-project

18 documents

my-project / Overview

Project Overview

A reading entry generated from your local repository to help developers understand structure, core modules, and team conventions faster.

export class EventPipeline { 
  constructor(private config: PipelineConfig) {}
  async process(event: RawEvent) { 
    const transformed = await
      this.transform(event);
    return this.sink.write(transformed);
  }
}

4. Commands

CommandDescription
zreadDefault CLI entry. Recommends the next step based on the current environment.
zread generateGenerate project docs for the current directory.
zread browseOpen generated docs for the current project in the browser.
zread loginLog in or configure an API key.
zread configView or update CLI configuration.
zread updateUpdate the CLI to the latest version.
zread versionShow the current CLI version.

To see the full help output, run:

zread --help

5. Where Docs Are Stored

After generation, docs are stored under .zread/ in the project directory:

.zread/
  state.json
  wiki/
    current
    versions/
      2026-03-12_1015_f3a91e/
      2026-03-15_1314_ab12cd/
    drafts/
  • .zread/wiki/current: the current docs
  • .zread/wiki/versions/: previous generated versions
  • .zread/wiki/drafts/: draft docs before generation is finished

This makes it easy to read the latest docs while still keeping older versions available. After installing Zread CLI, teammates can open the same project docs in the browser, which works well for internal repositories, private codebases, and onboarding scenarios.

Zread CLI