installation

Installation

Relevant source files

• README.md
• pyproject.toml

Prerequisites

RepoDocs requires Python 3.10 or later (requires-python = ">=3.10") and has zero runtime dependencies — it is implemented entirely against the Python standard library.

Sources: pyproject.toml:L9-L12, README.md:L8-L9

Two additional tools complete the toolchain:

Tool	Purpose	Install
uv	Runs and installs the repodocs CLI (uvx, uv tool install)	curl -LsSf https://astral.sh/uv/install.sh | sh
graphify	Builds the pre-computed knowledge graph (tree-sitter nodes/edges) that the pipeline reads before planning/generating pages	uv tool install graphifyy, or pass --no-graph to skip it

Sources: README.md:L42-L43

A coding-agent CLI backend is also required at generation time — Claude Code (default), OMP, or Codex CLI — selected via the REPODOCS_BACKEND environment variable. See the Choose an LLM backend section of the README for backend-specific login steps.

Sources: README.md:L87-L95

Ephemeral install (no clone, no install)

The quick-start path runs the full pipeline via uvx without installing anything persistently:

cd /path/to/project
uvx --from git+https://github.com/aryrabelo/repodocs repodocs-all .

This resolves and runs repodocs-all directly from the git repository for a single invocation, then opens repo-docs/wiki.html in a browser.

Sources: README.md:L45-L52

Persistent install

To keep repodocs and repodocs-all available on PATH across sessions:

uv tool install git+https://github.com/aryrabelo/repodocs
uv tool update-shell
repodocs --version

uv tool install installs the package as an isolated tool; uv tool update-shell ensures the tool's shim directory is on PATH.

Sources: README.md:L61-L69

The pyproject.toml declares two console-script entry points that this install path exposes: repodocs (repodocs.cli:cli) and repodocs-all (repodocs.cli:cli_all).

Sources: pyproject.toml:L17-L19

Build configuration notes

The package uses the hatchling build backend, with its version sourced dynamically from a VERSION = "..." pattern in src/repodocs/__init__.py. The wheel and sdist build targets both explicitly re-include src/repodocs/repo-docs-profile/AGENTS.md as a build artifact — this vendored contract file would otherwise be excluded because it matches the project's unanchored .gitignore rule for AGENTS.md; without the re-include, a wheel built from the sdist would be missing this file and backend_contract() would fail.

Sources: pyproject.toml:L27-L41

Upgrading

uv tool upgrade repodocs                                   # if installed as a tool
# or reinstall from git:
uv tool install --force git+https://github.com/aryrabelo/repodocs

Sources: README.md:L121-L127

Development install

For contributing to RepoDocs itself, the test suite is run with uv run --extra test pytest -q, which uses the test optional-dependency group (pytest>=8) declared in pyproject.toml.

Sources: README.md:L135-L138, pyproject.toml:L21-L22