# Pydoctor Docs

> Documentation for PyDoctor CLI

- Documentation: https://pydoctor-docs.thally.app
- GitHub: https://github.com/iamAgbaCoder/pydoctor-docs
- Full docs for LLMs: https://pydoctor-docs.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pydoctor-docs.thally.app/ai.txt
- Structured docs index (JSON): https://pydoctor-docs.thally.app/api/docs-index
- OpenAPI spec: https://pydoctor-docs.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://pydoctor-docs.thally.app/api/docs/{page-id}
- Search API: https://pydoctor-docs.thally.app/api/search?q={query}
- Capability manifest (skill): https://pydoctor-docs.thally.app/skill.md
- Agent guidance (editing these docs): https://pydoctor-docs.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pydoctor-docs.thally.app/api/mcp
- Agent readiness: https://pydoctor-docs.thally.app/api/agent-readiness
- Changelog feed (JSON Feed): https://pydoctor-docs.thally.app/changelog/feed.json
- Changelog feed (RSS): https://pydoctor-docs.thally.app/changelog/rss.xml

### Recommended workflow

1. Use this index, the search API, or `search_sections` / `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Documentation

### Getting Started

- [Introduction](https://pydoctor-docs.thally.app/): pydoctor-cli scans Python projects for security vulnerabilities, dependency problems, unused packages, environment issues, and CI/CD risks, then scores overall project health.
- [Quickstart](https://pydoctor-docs.thally.app/quickstart): Install pydoctor-cli, run your first diagnostic scan, and read the results.

### Reference

- [CLI Command Reference](https://pydoctor-docs.thally.app/cli/commands): Every pydoctor command, its options, defaults, scanner keys, and exit-code behavior.
- [Configuration](https://pydoctor-docs.thally.app/configuration): Configure pydoctor-cli scanning behavior, caching, timeouts, and concurrency through pyproject.toml and environment variables.
- [Scanners](https://pydoctor-docs.thally.app/scanners): Detection logic, issue codes, severity mapping, and limitations for every pydoctor-cli scanner.

### Guides

- [CI/CD integration](https://pydoctor-docs.thally.app/guides/ci-integration): Use pydoctor-cli as a quality gate in GitHub Actions or other CI pipelines to catch vulnerabilities, dependency conflicts, exposed secrets, and unpinned actions before merging.
- [Fixing issues](https://pydoctor-docs.thally.app/guides/fixing-issues): Use the pydoctor fix command to automatically upgrade vulnerable or outdated packages, resolve dependency conflicts, remove unused packages, and create a virtual environment.
- [Troubleshooting](https://pydoctor-docs.thally.app/guides/troubleshooting): Fix common pydoctor-cli problems, including the wrong pydoctor package, unreachable vulnerability database, unexpected CI failures, and inconsistent results across runners.

### Release Notes

- [Changelog](https://pydoctor-docs.thally.app/changelog): Release history for pydoctor-cli.