Getting Started

KodaDocs generates beautiful help documentation for your web application automatically. It analyzes your codebase, captures screenshots, and produces a complete help center powered by VitePress.

Installation

Install KodaDocs from PyPI:

pip install kodadocs

Or use uvx for one-time runs without installing:

uvx kodadocs generate .

Quick Start

The fastest way to get started is with Claude Code (recommended):

1. Add the MCP server to your Claude Code settings (~/.claude/settings.json):

{
  "mcpServers": {
    "kodadocs": {
      "command": "uvx",
      "args": ["kodadocs", "mcp"]
    }
  }
}

2. Open your project in Claude Code and tell Claude:

"Generate help docs for my app"

Claude will walk through the full pipeline — detecting your framework, discovering routes, capturing screenshots, and generating articles.

CLI Quick Start

For power users who prefer the CLI directly:

cd your-project
kodadocs generate .

This runs the full pipeline with smart defaults:

• Auto-detects your framework (Next.js, SvelteKit, Django, etc.)
• Discovers all routes in your application
• Captures screenshots if your app is running
• Generates documentation articles
• Builds a VitePress static site in ./docs/

What Gets Generated

KodaDocs produces a complete VitePress documentation site with:

• Getting started guide for your end users
• Feature guides for each major section of your app
• FAQ addressing common questions
• Troubleshooting guide based on error patterns found in your code
• Annotated screenshots with numbered callouts pointing to UI elements

The generated site is ready to deploy to Cloudflare Pages, Vercel, Netlify, or GitHub Pages.

Prerequisites

• Python 3.10+ — required for KodaDocs itself
• Node.js 18+ — required to build the VitePress site
• Anthropic API Key — set ANTHROPIC_API_KEY in your environment for AI-powered article generation (optional; without it, KodaDocs runs deterministic analysis only)
• Playwright — installed automatically for screenshot capture

Next Steps

• Using with Claude Code — the recommended workflow
• CLI Commands — all available commands
• Configuration — customize every aspect
• Deployment — publish your docs