Installation

pip / pipx (all platforms)

pip install agent-doc
# or
pipx install agent-doc

This installs a prebuilt wheel with the compiled binary — no Rust toolchain needed.

Shell installer (Linux & macOS)

curl -sSf https://raw.githubusercontent.com/btakita/agent-doc/main/install.sh | sh

This downloads a prebuilt binary to ~/.local/bin/agent-doc. Use --system to install to /usr/local/bin instead (requires sudo).

From source

# agent-doc uses a sibling tmux-router path dependency
git clone https://github.com/btakita/tmux-router.git
git clone https://github.com/btakita/agent-doc.git
cd agent-doc
cargo install --path .

make install also rebuilds already-installed editor packages. The JetBrains build requires JDK 21. In a monorepo checkout, an initialized sibling lazily-kt development build also requires sibling lazily-spec/proto; standalone checkouts use the published Lazily dependency instead.

Windows

pip install agent-doc is the easiest option. Alternatively, download .zip from GitHub Releases or build from source with cargo install --path ..