upgrading

Upgrading

Relevant source files

• README.md

Overview

RepoDocs is distributed as a uv tool installed directly from its GitHub repository rather than from a package index. There is no separate self-update command; upgrading reuses the same uv tool commands used for the initial install.

Sources: README.md:L62-L70, README.md:L164-L170

Upgrade commands

Scenario	Command
Already installed as a uv tool	uv tool upgrade repodocs
Force a clean reinstall from git	uv tool install --force repodocs

uv tool upgrade repodocs                                   # if installed as a tool
# or reinstall from git:
uv tool install --force repodocs

uv tool upgrade pulls the latest commit from the git+ source the tool was originally installed from. If the upgrade does not pick up expected changes (e.g. uv's git cache is stale), uv tool install --force reinstalls from git unconditionally.

Sources: README.md:L164-L170

Verifying the install

After installing or upgrading, confirm repodocs and repodocs-all are on PATH and check the version:

uv tool install repodocs
uv tool update-shell
repodocs --version

uv tool update-shell ensures the uv tool bin directory is on PATH so repodocs/repodocs-all resolve without a full shell restart.

Sources: README.md:L62-L70

Running without installing

For one-off runs against a specific commit or branch, uvx --from git+... fetches and runs RepoDocs without persisting a tool install, which sidesteps the upgrade question entirely since each invocation resolves the source fresh:

cd /path/to/project
uvx --from repodocs repodocs-all .

Sources: README.md:L46-L53

Optional diagram tool

The optional tools/diagram_poster.ts renderer (Bun + Playwright) is not managed by uv tool and has no separate upgrade path documented beyond re-running its own setup steps (bun install, bunx playwright install chromium) if dependencies change.

Sources: README.md:L103-L117