Zread

Editor Review

Run generation in the repository you want explained, without copying the code elsewhere. If it stops, run it again and choose to resume the draft so finished pages are not rewritten. The result stays in the project's wiki directory. The browse command opens it in a browser, and a version picker can reopen an earlier run. Interface language and document language are separate settings. With a Zhipu subscription, login supplies the key. To use another service, change the provider or enter a compatible endpoint, and adjust concurrency and retries. It fits teams that want an offline structured guide for a private repository and do not want the source uploaded to a documentation site.

AI Tools Navigator Editorial TeamUpdated: 2026-10-09

What is Zread

Zread is a command-line documentation tool for a local code repository, with its site at zread.ai. It uses a language model to analyze the current project and write a structured wiki, and running it in the repository starts an onboarding flow. The documents stay inside the project, and the official notes say they are not uploaded. Interface language and document language can be set separately to Chinese or English. An interrupted run can resume a draft, every run keeps a history, and the pages can be opened in a browser. The Windows package is published by Zhipu, and you can also bring your own key or a compatible endpoint.

Zread Key Features

Wiki from a local repository

Running it in a project analyzes the code and writes a structured wiki stored in a documentation directory inside the repository.

Resume an interrupted draft

After an interruption, run generate again and resume the draft from where it stopped. Finished pages are not generated twice.

Browse historical versions

Each run keeps a historical version. The browse command opens the current wiki in a browser or a version picker for earlier runs.

Choose a model provider

You can log in with a Zhipu subscription, enter a key for another provider, or point it at a compatible custom endpoint.

Zread Key Advantages

Documents stay in the project's wiki directory, and the official notes say they are not uploaded

An interrupted run can resume a draft so finished pages are not generated again

Every run keeps history, and the browse command can reopen it in a browser

You can log in with a Zhipu subscription or use your own key or a compatible endpoint

Zread Use Cases

Document a private repository

An engineering lead generates the wiki on a local repository so architecture and module notes stay in the project for offline reading.

Finish a wiki after a stop

When a long run is interrupted, a developer resumes the draft and fills only the unfinished pages instead of regenerating the repository.

Compare two generated editions

After the code changes, generate again and open the previous wiki in the version picker to see whether the module notes still match.

Frequently Asked Questions

▶Do the generated documents leave the machine?

The official FAQ says the documents are stored in the wiki folder inside the project, stay fully local, and are not uploaded. That suits teams that cannot send a private repository to an external indexing site. The browse command opens them in a local browser. Moving to another computer means copying that folder yourself. The tool does not offer cloud sync.

▶If generation stops halfway, do you start over?

You do not regenerate the whole repository. Run generate again and resume the draft. It continues from the interruption and leaves finished pages as they are. Each run also keeps history, and the browse command can open a version picker to compare an earlier outline. Concurrency and retries are settings in the config.

▶Can it be used without a Zhipu subscription?

Yes. Besides the Zhipu subscription channels, the config lists other providers that need your own key, and it accepts a compatible endpoint. The subscription login is what fetches a key automatically. Either way, login or configuration has to happen first. It does not analyze a repository before a model source is set.

Zread

Editor Review

What is Zread

Basic Info

Best For

Zread Key Features

Zread Key Advantages

Zread Use Cases

Frequently Asked Questions

Latest News

User Reviews

TRAE编程

通义灵码

文心快码

豆包AI编程

Cursor

GitHub Copilot

代码小浣熊

Kiro

Zread

Editor Review

What is Zread

Basic Info

Best For

Zread Key Features

Zread Key Advantages

Zread Use Cases

Frequently Asked Questions

Latest News

User Reviews

Related Tools

TRAE编程

通义灵码

文心快码

豆包AI编程

Cursor

GitHub Copilot

代码小浣熊

Kiro