FFFF GitHub - brianminhle/CodeDocumentation Β· GitHub
[go: up one dir, main page]

Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

6 Commits

Folders and files

Repository files navigation

Quick Start

1. Install codedocumentation

# Install from source
pip install git+https://github.com/AnhMinh-Le/CodeDocumentation.git

# Verify installation
codedocumentation --version

2. Configure Your Environment

codedocumentation supports multiple models via an OpenAI-compatible SDK layer.

codedocumentation config set \
  --api-key YOUR_API_KEY \
  --base-url https://api.anthropic.com \
  --main-model claude-sonnet-4 \
  --cluster-model claude-sonnet-4 \
  --fallback-model glm-4p5

3. Generate Documentation

# Navigate to your project
cd /path/to/your/project

# Generate documentation
codedocumentation generate

# Generate with HTML viewer for GitHub Pages
codedocumentation generate --github-pages --create-branch

That's it! Your documentation will be generated in ./docs/ with comprehensive repository-level analysis.

Usage Example

CLI Usage Example


What is codedocumentation?

codedocumentation is an open-source framework for automated repository-level documentation across seven programming languages. It generates holistic, architecture-aware documentation that captures not only individual functions but also their cross-file, cross-module, and system-level interactions.

Supported Languages

🐍 Python β€’ β˜• Java β€’ 🟨 JavaScript β€’ πŸ”· TypeScript β€’ βš™οΈ C β€’ πŸ”§ C++ β€’ πŸͺŸ C#


CLI Commands

Configuration Management

# Set up your API configuration
codedocumentation config set \
  --api-key <your-api-key> \
  --base-url <provider-url> \
  --main-model <model-name> \
  --cluster-model <model-name> \
  --fallback-model <model-name>

# Configure max token settings
codedocumentation config set --max-tokens 32768 --max-token-per-module 36369 --max-token-per-leaf-module 16000

# Configure max depth for hierarchical decomposition
codedocumentation config set --max-depth 3

# Show current configuration
codedocumentation config show

# Validate your configuration
codedocumentation config validate

Documentation Generation

# Basic generation
codedocumentation generate

# Custom output directory
codedocumentation generate --output ./documentation

# Create git branch for documentation
codedocumentation generate --create-branch

# Generate HTML viewer for GitHub Pages
codedocumentation generate --github-pages

# Enable verbose logging
codedocumentation generate --verbose

# Full-featured generation
codedocumentation generate --create-branch --github-pages --verbose

Customization Options

codedocumentation supports customization for language-specific projects and documentation styles:

# C# project: only analyze .cs files, exclude test directories
codedocumentation generate --include "*.cs" --exclude "Tests,Specs,*.test.cs"

# Focus on specific modules with architecture-style docs
codedocumentation generate --focus "src/core,src/api" --doc-type architecture

# Add custom instructions for the AI agent
codedocumentation generate --instructions "Focus on public APIs and include usage examples"

Pattern Behavior (Important!)

  • --include: When specified, ONLY these patterns are used (replaces defaults completely)

    • Example: --include "*.cs" will analyze ONLY .cs files
    • If omitted, all supported file types are analyzed
    • Supports glob patterns: *.py, src/**/*.ts, *.{js,jsx}
  • --exclude: When specified, patterns are MERGED with default ignore patterns

    • Example: --exclude "Tests,Specs" will exclude these directories AND still exclude .git, __pycache__, node_modules, etc.
    • Default patterns include: .git, node_modules, __pycache__, *.pyc, bin/, dist/, and many more
    • Supports multiple formats:
      • Exact names: Tests, .env, config.local
      • Glob patterns: *.test.js, *_test.py, *.min.*
      • Directory patterns: build/, dist/, coverage/

Setting Persistent Defaults

Save your preferred settings as defaults:

# Set include patterns for C# projects
codedocumentation config agent --include "*.cs"

# Exclude test projects by default (merged with default excludes)
codedocumentation config agent --exclude "Tests,Specs,*.test.cs"

# Set focus modules
codedocumentation config agent --focus "src/core,src/api"

# Set default documentation type
codedocumentation config agent --doc-type architecture

# View current agent settings
codedocumentation config agent

# Clear all agent settings
codedocumentation config agent --clear
Option Description Behavior Example
--include File patterns to include Replaces defaults *.cs, *.py, src/**/*.ts
--exclude Patterns to exclude Merges with defaults Tests,Specs, *.test.js, build/
--focus Modules to document in detail Standalone option src/core,src/api
--doc-type Documentation style Standalone option api, architecture, user-guide, developer
--instructions Custom agent instructions Standalone option Free-form text

Token Settings

codedocumentation allows you to configure maximum token limits for LLM calls. This is useful for:

  • Adapting to different model context windows
  • Controlling costs by limiting response sizes
  • Optimizing for faster response times
# Set max tokens for LLM responses (default: 32768)
codedocumentation config set --max-tokens 16384

# Set max tokens for module clustering (default: 36369)
codedocumentation config set --max-token-per-module 40000

# Set max tokens for leaf modules (default: 16000)
codedocumentation config set --max-token-per-leaf-module 20000

# Set max depth for hierarchical decomposition (default: 2)
codedocumentation config set --max-depth 3

# Override at runtime for a single generation
codedocumentation generate --max-tokens 16384 --max-token-per-module 40000 --max-depth 3
Option Description Default
--max-tokens Maximum output tokens for LLM response 32768
--max-token-per-module Input tokens threshold for module clustering 36369
--max-token-per-leaf-module Input tokens threshold for leaf modules 16000
--max-depth Maximum depth for hierarchical decomposition 2

Configuration Storage

  • API keys: Securely stored in system keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service)
  • Settings & Agent Instructions: ~/.codedocumentation/config.json

Documentation Output

Generated documentation includes both textual descriptions and visual artifacts for comprehensive understanding.

Textual Documentation

  • Repository overview with architecture guide
  • Module-level documentation with API references
  • Usage examples and implementation patterns
  • Cross-module interaction analysis

Visual Artifacts

  • System architecture diagrams (Mermaid)
  • Data flow visualizations
  • Dependency graphs and module relationships
  • Sequence diagrams for complex interactions

Output Structure

./docs/
β”œβ”€β”€ overview.md              # Repository overview (start here!)
β”œβ”€β”€ module1.md               # Module documentation
β”œβ”€β”€ module2.md               # Additional modules...
β”œβ”€β”€ module_tree.json         # Hierarchical module structure
β”œβ”€β”€ first_module_tree.json   # Initial clustering result
β”œβ”€β”€ metadata.json            # Generation metadata
└── index.html               # Interactive viewer (with --github-pages)

How It Works

Architecture Overview

codedocumentation employs a three-stage process for comprehensive documentation generation:

  1. Hierarchical Decomposition: Uses dynamic programming-inspired algorithms to partition repositories into coherent modules while preserving architectural context across multiple granularity levels.

  2. Recursive Multi-Agent Processing: Implements adaptive multi-agent processing with dynamic task delegation, allowing the system to handle complex modules at scale while maintaining quality.

  3. Multi-Modal Synthesis: Integrates textual descriptions with visual artifacts including architecture diagrams, data-flow representations, and sequence diagrams for comprehensive understanding.

Data Flow

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   Codebase      │───▢│  Hierarchical    │───▢│  Multi-Agent    β”‚
β”‚   Analysis      β”‚    β”‚  Decomposition   β”‚    β”‚  Processing     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                β”‚                        β”‚
                                β–Ό                        β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   Visual        │◀───│  Multi-Modal     │◀───│  Structured     β”‚
β”‚   Artifacts     β”‚    β”‚  Synthesis       β”‚    β”‚  Content        β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Requirements

  • Python 3.12+
  • Node.js (for Mermaid diagram validation)
  • LLM API access (Anthropic Claude, OpenAI, etc.)
  • Git (for branch creation features)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0