docforge-gen 0.1.0

Automatically generate documentation for any GitHub repository using LLMs

DocForge

AI-powered documentation generator for any GitHub repository or local project.

Quick Start

pip install docforge

# From GitHub URL
docforge generate https://github.com/user/repo

# From local path
docforge generate ./my-project

# With Ollama (local, free)
docforge generate ./my-project --model ollama/llama3 --api-base http://localhost:11434

What it generates

• README.md — Comprehensive project overview
• INSTALLATION.md — Setup and installation guide
• ARCHITECTURE.md — System architecture with Mermaid diagrams
• CHANGELOG.md — Formatted changelog from git history
• api/*.md — Per-module API reference docs
• mkdocs.yml — Optional MkDocs site config (--mkdocs)
• .github/workflows/auto-docs.yml — Optional GitHub Action (--github-action)

Supported Languages

Python, JavaScript, TypeScript, Go, Rust, Java

Supported LLM Providers

• OpenAI (default): --model gpt-4o
• Anthropic Claude: --model claude-sonnet-4-6
• Ollama (local): --model ollama/llama3 --api-base http://localhost:11434
• Any provider supported by LiteLLM

License

MIT