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

$3

``bash
npm install -g dev-doc
`

Or use it directly without installing:

`bash
npx dev-doc ./src
`

$3

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

$3

`bash
dev-doc add-key
`

Or use the login alias:

`bash
dev-doc login
`

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

$3

`bash
dev-doc
`

Or analyze a specific directory:

`bash
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

$3

Analyze current directory:
`bash
dev-doc
`

Analyze a specific directory:
`bash
dev-doc ./src
`

Check your account status and quota:
`bash
dev-doc status
`

Add or update your API key:
`bash
dev-doc add-key
`

$3

Specify a custom project name:
`bash
dev-doc ./src --project-name "my-awesome-project"
`

Ignore specific directories:
`bash
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

$3

`bash
dev-doc
`

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

$3

`bash
dev-doc ./src
dev-doc ./backend
`

$3

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

$3

`bash
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:

$3

No API key found?
`bash
dev-doc add-key
`

Check your quota and usage:
`bash
dev-doc status
`

Project name not detected?
`bash
dev-doc ./src --project-name "my-project"
``

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

📄 License

MIT