agentic-pydoc

Static Python codebase intelligence and documentation for AI agents.

Installation

Requires Python 3.13+.

Install as an isolated tool (recommended):

uv tool install agentic-pydoc

Or with pipx:

python -m pip install --user pipx
python -m pipx ensurepath
pipx install agentic-pydoc

Then verify the install from any directory:

agentic-pydoc --help
agentic-pydoc --version

Development

Contributors clone the repository and sync the environment instead:

git clone <repository-url>
cd agentic-pydoc
uv sync
uv run agentic-pydoc --help

Commands

uv run agentic-pydoc scan
uv run agentic-pydoc update
uv run agentic-pydoc check
uv run agentic-pydoc history
uv run agentic-pydoc show sql_model.repositories.base.BaseRepository
uv run agentic-pydoc callers sql_model.repositories.base.BaseRepository.create
uv run agentic-pydoc callees sql_model.repositories.base.BaseRepository.create
uv run agentic-pydoc deps sql_model.repositories.base.BaseRepository

The tool generates docs/reference/index.json and MDX pages under docs/reference/.

See the complete API reference for the CLI, configuration, Python models, analyzers, index schema, and generators.

See incremental indexing architecture for scan baselines, Git updates, persistence, cache, and static-analysis limits.