docgen-ai
v0.1.1
Published
AI-powered codebase documentation generator. Analyzes repos via AST parsing and generates architecture docs, API references, module guides, and onboarding material.
Maintainers
Readme
@docgen/cli
Autonomous Codebase Documentation Platform — AI-powered technical documentation generator
[AI summarization disabled — enable in config to get human-readable descriptions]
Technology Stack
Languages:
- Typescript — 21 files (100%)
Frameworks & Libraries:
- Express
Key Dependencies:
- Framework: express
- Logging: winston
Getting Started
Prerequisites
- Node.js >= 18.0.0
Installation
# Clone the repository
git clone <repository-url>
cd @docgen/cli
# Install dependencies
npm installEnvironment Variables
Create a .env file in the project root:
ANTHROPIC_API_KEY=<required>
DOCGEN_AI_KEY=<required>
DOCGEN_AI_PROVIDER=<required>
DOCGEN_AI_MODEL=<required>
DOCGEN_OUTPUT_DIR=<required>
DOCGEN_LOG_LEVEL=<required>Running the Application
# Development
npm run dev
# Production
npm startAPI Overview
This project exposes 1 API endpoint.
| Method | Path | Handler | Auth |
|--------|------|---------|------|
| GET | * | anonymous | — |
Project Structure
ai/ (1 files)
cli/ (1 files — api)
config/ (1 files — config)
core/analyzers/ (1 files)
core/cache/ (1 files)
core/generators/ (8 files)
core/parsers/ (3 files)
core/ (1 files)
root/ (1 files)
types/ (1 files)
utils/ (2 files — utility)Infrastructure
- .github/workflows — GitHub Actions CI/CD
- tsconfig.json — TypeScript config
Testing
Testing framework: jest, ts-jest
npm testDocumentation generated by docgen on 2026-03-19
