dev-doc

AI-powered codebase analyzer that automatically generates comprehensive documentation and insights about your codebase using AI.

✨ What is dev-doc?

dev-doc scans your codebase, analyzes it with AI, and generates detailed documentation including:

• API Documentation: Automatically detects and documents all endpoints, their relationships, and authentication flows
• Structured Analysis: Organized documentation with overview, architecture, tech stack, and key features
• Code Optimization Insights: Actionable recommendations to improve performance, reduce latency, and enhance code quality
• Project Organization: Clear ownership tracking with project names for easy management

All documentation is securely stored in your dashboard where you can access it anytime.

🚀 Quick Start

Step 1: Install

npm install -g dev-doc

Or use it directly without installing:

npx dev-doc ./src

Step 2: Get Your API Key

1. Visit devdoc.tellecata.com
2. Sign up for a free account
3. Navigate to your dashboard
4. Copy your API key

Step 3: Add Your API Key

dev-doc add-key <your-api-key>

Or use the login alias:

dev-doc login <your-api-key>

You'll see a confirmation with your quota and usage information.

Step 4: Analyze Your Codebase

dev-doc

Or analyze a specific directory:

dev-doc ./src

That's it! Your analysis will be processed in the background and saved to your dashboard. The CLI will exit immediately after queuing the analysis.

Note: Running dev-doc without arguments analyzes the current directory, making it perfect for running from your project root.

📖 Usage

Basic Commands

Analyze current directory:

dev-doc

Analyze a specific directory:

dev-doc ./src

Check your account status and quota:

dev-doc status

Add or update your API key:

dev-doc add-key <your-api-key>

Options

Specify a custom project name:

dev-doc ./src --project-name "my-awesome-project"

Ignore specific directories:

dev-doc ./src --ignore node_modules,dist,tests,.next

Default behavior:

• Project name is automatically extracted from package.json (if present) or the directory name
• Default ignored directories: node_modules, .git, dist, build, .next

📋 Examples

Analyze current directory (most common)

dev-doc

This analyzes the current directory - perfect when you're in your project root!

Analyze a specific directory

dev-doc ./src
dev-doc ./backend

Analyze with custom project name

dev-doc --project-name "api-backend"
dev-doc ./src --project-name "api-backend"

Exclude test files and build directories

dev-doc --ignore tests,coverage,build,.next
dev-doc ./src --ignore tests,coverage,build,.next

🎯 Features

• 🔍 Smart Detection: Automatically identifies APIs, endpoints, and their relationships
• ⚡ Background Processing: Analysis runs asynchronously - no waiting for completion
• 📊 Structured Documentation: Organized into separate fields (overview, architecture, APIs, tech stack)
• 🎯 Optimization Insights: Actionable recommendations for performance, latency, and code quality
• 📦 Project Organization: Clear project naming and ownership tracking
• 🔒 Secure: Your code is processed securely and stored in your private dashboard
• 🚀 No Configuration: Works out of the box with sensible defaults

💡 What You'll Get

After running an analysis, you'll have access to:

Structured Documentation

• Overview: Brief project description
• Architecture: Detailed system architecture and design patterns
• Tech Stack: Complete list of frameworks, libraries, and tools used
• API Endpoints: Comprehensive list of all endpoints with methods, paths, descriptions, and authentication requirements
• Key Features: List of main functionality and capabilities
• Dependencies: Core package dependencies

API Documentation

• Every endpoint with HTTP methods and paths
• Authentication and authorization requirements
• API relationships and dependencies
• Data flows between endpoints

Code Optimization Insights

• Performance Bottlenecks: Identifies N+1 queries, missing indexes, inefficient algorithms
• API Latency Improvements: Caching strategies, query optimizations, response compression suggestions
• Code Quality Enhancements: Code smells, refactoring opportunities, security improvements
• Architecture Improvements: Better patterns, scalability suggestions, maintainability enhancements

Project Summary

• High-level overview of your architecture and tech stack
• Complete API endpoint catalog
• Authentication flows and patterns
• File-by-file analysis documentation

All documentation is accessible through your dashboard at devdoc.tellecata.com.

🔄 How It Works

1. Queue Analysis: CLI sends your codebase to the backend and receives immediate confirmation
2. Background Processing: Analysis runs asynchronously on the server (no timeout issues)
3. AI Analysis: Files are analyzed for APIs, architecture, and code patterns
4. Structured Extraction: Documentation is organized into structured fields
5. Storage: Results are saved to your dashboard with clear project ownership
6. Access: View comprehensive documentation anytime in your dashboard

❓ Troubleshooting

No API key found?

dev-doc add-key <your-api-key>

Check your quota and usage:

dev-doc status

Project name not detected?

dev-doc ./src --project-name "my-project"

Need help? Visit devdoc.tellecata.com for support and documentation.

📄 License

MIT