Skip to main content

AI-powered documentation engine for vibe coders

Project description

Docuson

AI-Powered Documentation Engine for Vibe Coders

Docuson scans your codebase and generates complete, professional documentation in minutes — architecture diagrams, API references, security audits, database schemas, and more. One command. Works with code generated by Cursor, GitHub Copilot, Claude Code, and any AI coding tool.

Why Docuson

  • 41% of all code is now AI-generated (GitHub, 2025) — but nobody documents it
  • 2.7x more vulnerabilities in AI-generated code vs human-written (Veracode)
  • 69% of developers lose 8+ hours weekly to poor documentation

Docuson is the documentation layer between you and your AI-generated code.

Installation

pip install docuson

Quick Start

# Initialize in your project
docuson init

# Scan your codebase (free, no API calls)
docuson scan

# Generate full documentation
docuson generate

# Preview the HTML docs locally
docuson serve

What Docuson Generates

9 Specialized Analysis Passes

Pass What It Covers
Architecture System overview, tech stack, design patterns, project structure
Data Layer Database schema, ER diagrams, ORM analysis, migrations
API Layer All endpoints, middleware, request/response schemas
Business Logic Features, user flows, business rules, state machines
Frontend Component hierarchy, state management, routing
Security Auth system, vulnerabilities, secrets, OWASP flags
Infrastructure Docker, CI/CD, deployment, monitoring
Cross-cutting Error handling, logging, caching, config
Synthesis Executive summary, health score, setup guide, glossary

Dual-View Output

  • Business View — Plain English for founders, PMs, investors
  • Developer View — Technical deep-dive with code references

Output Formats

  • Markdown (default)
  • HTML site with search, dark mode, sidebar navigation
  • PDF with cover page, TOC, diagrams

Supported Languages (30+)

TypeScript, JavaScript, Python, Java, Kotlin, Go, Rust, Ruby, PHP, C#, Swift, Dart, C/C++, Scala, Elixir, and more — powered by Tree-sitter AST parsing.

Supported Frameworks (20+)

Next.js, React, FastAPI, Django, Flask, Express, Spring Boot, Rails, Laravel, Flutter, Gin, Actix-web, ASP.NET, Ktor, Nuxt, SvelteKit, Remix, Angular, Vue, and more.

All CLI Commands

docuson init          # Initialize in a project
docuson scan          # Scan codebase (free, no API)
docuson generate      # Generate documentation
docuson serve         # Preview HTML docs locally
docuson status        # Show documentation status
docuson diff          # Show changes since last generation
docuson usage         # Show token usage and budget
docuson github <url>  # Document a GitHub repo
docuson assist        # Live Assistant (real-time code notes)
docuson mcp-serve     # Start MCP server for AI tool integration
docuson config show   # Show configuration

VS Code Extension

Install the Docuson extension for VS Code / Cursor:

  • Generate docs from the command palette
  • Status bar showing documentation state
  • Live Assistant with inline diagnostics
  • Sidebar with project status and quick actions

MCP Server (AI Tool Integration)

Docuson exposes project knowledge via MCP so Claude Code, Copilot, and other AI tools can query your docs:

{
  "mcpServers": {
    "docuson": {
      "command": "docuson",
      "args": ["mcp-serve", "--path", "/your/project"]
    }
  }
}

Configuration

# Set your Anthropic API key
export DOCUSON_API_KEY=sk-ant-...

# Or configure interactively
docuson config set-key

Configuration lives in .docuson/config.yaml. See docuson config show for current settings.

Requirements

  • Python 3.10+
  • Anthropic API key (for generate command — scan is free)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docuson-0.1.0b1.tar.gz (179.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docuson-0.1.0b1-py3-none-any.whl (135.3 kB view details)

Uploaded Python 3

File details

Details for the file docuson-0.1.0b1.tar.gz.

File metadata

  • Download URL: docuson-0.1.0b1.tar.gz
  • Upload date:
  • Size: 179.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for docuson-0.1.0b1.tar.gz
Algorithm Hash digest
SHA256 f024e5b5ed42abb1094d22432be45faf6febd93469cd31255ba98881b8368b88
MD5 a6889c9d60a0b5b4d1cb34f931263079
BLAKE2b-256 8e8f6e9da7742626d2aa6075bb782f0ec2514e3e444c1d2b9eda5e0c7e91fe7d

See more details on using hashes here.

File details

Details for the file docuson-0.1.0b1-py3-none-any.whl.

File metadata

  • Download URL: docuson-0.1.0b1-py3-none-any.whl
  • Upload date:
  • Size: 135.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for docuson-0.1.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a542df4ae3bb9b964621037306aaab81f95239eb2b6ea232e31e04e13038c36
MD5 83e0545b3257385a50e9d3e3a1d8421e
BLAKE2b-256 68d750f8c00b4be46bd4b348de9bef522cb3b4de3c1d8269c81232a48975eda9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page