yread

Turn a local source repository into an architecture-first Markdown wiki.

yread is a lightweight, installable Python CLI — turn a local repository into an architecture-first Markdown wiki, powered by LLMs. Inspired by zread.

Why

Zread popularized the idea of generating a developer guide from a GitHub repository. yread keeps the same core idea, but narrows the scope:

• Local repositories only
• Direct OpenAI-compatible provider calls
• A small, readable Python implementation
• Markdown output focused on human architectural understanding

This is not a hosted wiki platform. It is a local project-understanding tool.

How It Works

yread runs two LLM-driven phases:

Phase 1: Catalog Agent
  Inspect the repository
  Build a lightweight project profile
  Plan architecture-first topics with evidence paths

Phase 2: Page Agents
  Start one fresh conversation per topic
  Inspect evidence files
  Write human-oriented architecture and maintenance guidance

Agents only receive three read-only tools:

Install and Run

Install from PyPI:

uv tool install yread        # or: pipx install yread, pip install yread

generate defaults to the current directory:

cd /path/to/repo
yread generate               # or: yread generate /path/to/repo

From a checkout, run without installing:

uv run yread generate /path/to/repo

Output defaults to:

<repo>/.yread/
├── wiki/
│   └── <slug>.md
├── wiki.json
├── manifest.json
└── SUMMARY.md

Project Profile

Inspect a repository's profile without calling an LLM — a dense, at-a-glance read on a project's size, languages, and activity:

yread profile               # or: yread profile /path/to/repo

  repo                                               /path/to/repo
  A small tool that does one thing well

  CODE ───────────────────────────────────────────────────────────
    Lines of code  14,695    excludes blanks and comments
    Source files      237    of 320 files · 6 levels deep
    Avg per file       62    lines
    Test lines        531    0.04× of source · 3 files
    Structure                Package.swift, Podfile
    Entry                    Sources/App/main.swift

  LANGUAGES ──────────────────────────────────────────────────────
    Swift           7,673    ██████████████  54%
    Objective-C     4,888    ████████▉       35%
    C/C++             831    █▌               6%
    Go                692    █▎               5%

  REPOSITORY ─────────────────────────────────────────────────────
    Commits            18    5 in the last 30 days
    Contributors        3
    History                  2025-09-25 → 2026-07-06
    Version                  v0.3.0
    GitHub                   owner/repo · MIT
    Stars             128    12 forks · 4 open issues
    Pushed                   2026-07-06

Every row is the same three columns — what it is, the figure, and the detail — so each section's numbers stack into one column you can scan straight down.

Every line count is core code — blank and comment-only lines are excluded, and bundled dependencies (Pods, Carthage, vendor, 3rdparty, build output, …) are skipped, so the numbers track the team's own logic. The LANGUAGES section lists each language's core code lines and sums to Lines of code. Tests are counted separately and shown as a ratio of core code.

For any git repository the REPOSITORY section adds commit count, history span (first/last commit dates), commits in the last 30 days, contributor count, latest tag, and whether the working tree is dirty — all from local git, no network.

When the repo's origin remote points to GitHub, the same section grows a few rows from a single API call: description (shown under the title), stars, forks, open issues, license, last push, and archived/fork flags. Set GITHUB_TOKEN for higher rate limits and private repos. On failure the Stars row shows n/a with the reason (offline or HTTP <code>, e.g. a rate-limited or private repo).

Documentation Mode

Not every repository is a conventional software project. For ML / model projects — training, fine-tuning, conversion, or deployment — the substance lives in configs, training recipes, and model artifacts, which a pure architecture view under-weights.

MODE selects the documentation mode. It is explicit — there is no auto-detection:

• software (default) — the standard architecture-first lens.
• ml — model-first. The profile detects the repo's model families (grouping weights and their config.json under each model directory), and the catalog plans one page per model — its architecture, provenance, input/output tensors, and label taxonomy (id2label) — with the serving/conversion code as supporting pages, not the headline. It unlocks the topic kinds model-architecture, data-pipeline, model-conversion, model-serving, training, and evaluation. Binary weights are never read as text — the agent infers each model from its config.json, modeling code, and export/convert scripts. Generic software pages are demoted to at most one.

yread config set MODE ml        # switch to the ML lens
yread generate /path/to/repo --mode ml   # or per run

To decide which mode a repo needs, run yread profile. An ASSETS section surfaces model weights and datasets — the files a source-line count ignores — and, when it finds them, a MODELS section names each detected model family and its architecture:

  ASSETS ─────────────────────────────────────────────────────────
    weights             9    files · 2.9 GB · .om×4 .onnx×4 .pth×1
    data                3    files · 40.0 MB · .wav×3

  MODELS ─────────────────────────────────────────────────────────
    audio_model              ASTForAudioClassification · .om .onnx .pth
    image_model              ? · .om .onnx

If it lists models, reach for --mode ml.

Provider Configuration

yread can use minimax-cn, deepseek, or any OpenAI Chat Completions compatible endpoint.

For a generic OpenAI-compatible provider:

cp .env.yread.example .env.yread
$EDITOR .env.yread
uv run yread generate /path/to/repo --env-file .env.yread

All tunables (provider, model, language, depth, concurrency, output) live in config rather than on the generate command, keeping the command surface lean.

Persistent config lives at:

~/.yread/config.env

Set it up interactively:

yread config init

Or manage individual keys:

yread config path
yread config set PROVIDER openai-compatible
yread config set BASE_URL https://api.example.com/v1
yread config set API_KEY sk-...
yread config set MODEL your-model
yread config set DOC_LANG en
yread config set DEPTH standard
yread config show

Config precedence is:

YREAD_* environment variable > --env-file > ~/.yread/config.env > defaults

Keys are unprefixed in the config file, in --env-file, and with config set (a dedicated file can't clash with anything). As a shell environment variable, prefix the key with YREAD_ so common bare names never collide with unrelated variables:

YREAD_MODE=ml YREAD_DEPTH=deep yread generate /path/to/repo

For minimax-cn and deepseek, missing credentials are resolved from ~/.pi/agent/models.json and ~/.pi/agent/auth.json when available.

Export to Obsidian

Set OUTPUT_DIR to a directory inside your vault:

yread config set OUTPUT_DIR "/path/to/Obsidian Vault/Code Wikis/yread"
yread generate /path/to/repo

Overwrite and Resume

A plain yread generate rebuilds the catalog and overwrites the current output under .yread/. Markdown pages live in .yread/wiki/; wiki.json, manifest.json, and SUMMARY.md live directly under .yread/.

If a previous run was interrupted or left failed pages, explicitly resume the current output, regenerating only missing, failed, or source-affected pages:

yread generate /path/to/repo --resume

Resume and browse require the current v2 wiki schema.

Regenerate one page by slug, title, or Markdown filename:

yread generate /path/to/repo --page 1-overview

Disable shell access for agents (config-only):

yread config set ENABLE_SHELL 0

Browse Locally

The source repository is recorded in wiki.json at generation time, so source citations resolve automatically — from inside the repo, just run:

yread browse                       # serves ./.yread

Or point at a wiki explicitly; --repo overrides the recorded source root:

uv run yread browse /path/to/repo/.yread --host localhost --port 8000

Deploy as a Website

Point browse at a directory of wikis instead of a single one and it becomes a multi-wiki site: each subdirectory that is a yread output (or has a default .yread/ one) is mounted at /w/<name>/, and / lists every project. The index rescans on every visit, so uploading a new wiki needs no restart.

yread browse /srv/wikis --host 127.0.0.1 --port 8000

Layout on the server — either shape works:

/srv/wikis/
├── projA/wiki.json + wiki/...       # wiki dir is the project dir itself
└── projB/.yread/wiki.json + wiki/...# or the default output layout

Multi-wiki mode is safe to expose publicly: source citations stay inert and /src/ is closed unless you pass --enable-source, so a source_root recorded at generation time can't leak a source tree. Put it behind a reverse proxy for TLS — nginx example:

server {
    listen 443 ssl;
    server_name wiki.example.com;
    # ssl_certificate / ssl_certificate_key ...
    location / {
        proxy_pass http://127.0.0.1:8000;
        proxy_set_header Host $host;
    }
}

And a systemd unit to keep it running:

[Unit]
Description=yread wiki browser
After=network.target

[Service]
ExecStart=/usr/local/bin/yread browse /srv/wikis --host 127.0.0.1 --port 8000
Restart=always

[Install]
WantedBy=multi-user.target

Publish a wiki by copying the generated wiki.json and wiki/ into /srv/wikis/<name>/ (e.g. rsync -a repo/.yread/ vps:/srv/wikis/repo/); it shows up on the index immediately.

Codex Skill

A companion Codex skill is available at skills/yread/SKILL.md.

Install it for local discovery:

cp -R skills/yread "${CODEX_HOME:-$HOME/.codex}/skills/"

Example Output

See examples/sample-wiki for a static sample of the v2 output layout. It demonstrates wiki.json, manifest.json, and Markdown page files; it is not a real model-generated run.

Development

uv run --dev pytest -q
uv build

Privacy

yread runs locally, but source snippets read by its tools are sent to the configured LLM provider. Do not run it on private or sensitive repositories unless that provider is acceptable for the code.

The file-reading tools block common secret files such as .env, private keys, and credential files. run_bash uses an allowlist and does not invoke a shell.

Design Notes

• No hosted service: output is local Markdown.
• No AST parser: repository understanding is LLM-driven.
• Architecture-first pages: source paths are evidence, not the page structure.
• No symbolic incremental engine: resume uses a file-level manifest plus per-page evidence paths.
• Standard package layout: src/yread/core.py for generation, src/yread/cli.py for CLI/config, and src/yread/viewer.py for the local browser.

Related Projects

• zread.ai
• ZreadAI/zread_cli
• bb-boy680/open-zread
• ejfkdev/zread

License

MIT