Stop writing documentation. Start generating it.
The AI-powered documentation framework that lives inside your IDE. Generate Architecture Decision Records, system diagrams, and onboarding guides with simple slash commands. No installations, no setup, no excuses.
🎯 Zero Installation → Copy 1 folder, start documenting
🤖 AI-Powered → Analyzes your code to generate contextual docs
⚡ Instant Results → Type /init-docs and watch magic happen
🔄 Always Fresh → Docs that sync with your codebase automatically
🛡️ Security First → Static analysis by default, no code execution
# In Cursor IDE (Chat with Agent Mode), just type:
/init-docs # 📚 Scaffold complete documentationResult: Professional documentation that would take hours to write, generated in seconds.
Auto-generated architecture overview with intelligent component mapping:
Context-aware onboarding documentation tailored to your project:
Comprehensive setup guides with framework-specific instructions:
Professional ER diagrams and database schema documentation:
Want to see the quality? This project uses its own framework! Check out the docs/ folder to see:
- 📋 Architecture Overview - Complete system design with Mermaid diagrams
- 🚀 Developer Onboarding - Step-by-step setup guide
- 🗂️ Data Model - Framework structure with ER diagram
- 📚 API Documentation - Complete slash command reference
- 🏛️ Architecture Decisions - 4 ADRs documenting key framework decisions
Every single document was generated by the framework itself - that's the power of AI-driven documentation! 🤖✨
# 1. Clone this repo
git clone https://github.com/mgiovani/ai-cursor-init.git
# 2. Copy to your project (ONLY ONE FOLDER!)
cp -r ai-cursor-init/.cursor/ your-project/
# 3. Open your project in Cursor and type:
/init-docsThat's it! The framework analyzes your project and generates all useful documentation automatically:
- Always: Architecture overview, onboarding guide, ADRs
- If database models found: ER diagrams, database operations guide
- If API endpoints found: API documentation, security flows
- If deployment configs found: Infrastructure and deployment docs
- If open source/team project: Contributing guidelines, RFC templates
Don't want certain documentation? Create .cursor-init.yaml to disable specific types:
# .cursor-init.yaml (optional - only to disable unwanted docs)
documentation:
data:
database_ops: false # Skip database operations guide
infrastructure:
deployment: false # Skip deployment documentation
security: false # Skip security flow diagrams
development:
rfc: false # Skip RFC template setup| Command | What It Does | AI Enhancement | Time Saved |
|---|---|---|---|
/init-docs |
Complete documentation scaffold | Context-aware generation | 2-3 hours |
/adr "Decision" |
Architecture Decision Record | Project-specific insights | 30-45 min |
/gen-er-diagram |
Database schema visualization | Auto-detection & relationships | 1-2 hours |
/gen-arch-diagram |
System architecture diagram | Intelligent component mapping | 1-2 hours |
/update-docs |
Sync docs with code changes | Smart content enhancement | 30-60 min |
/check-docs |
Quality validation & freshness | Semantic analysis | 15-30 min |
Total time saved per project: 6-10 hours ⏰
docs/
├── 📋 architecture.md # System overview & components
├── 🚀 onboarding.md # Setup guide for new developers
├── 🗂️ data-model.md # ER diagrams & database schema
├── adr/ # Architecture Decision Records
│ ├── 0001-record-architecture-decisions.md
│ ├── 0002-choose-database-technology.md
│ └── 0003-api-authentication-strategy.md
└── rfc/ # Request for Comments
├── new-feature-proposal.md
└── api-versioning-strategy.md
Every file is:
- ✅ Contextual - Generated from your actual code
- ✅ Professional - Follows industry best practices
- ✅ Maintainable - Updates automatically with code changes
- ✅ Version Controlled - Markdown files alongside your code
/init-docs- Set up complete documentation structure/update-docs- Refresh documentation with code changes/check-docs- Validate documentation quality
/adr "Decision Title"- Create new ADR with context/rfc "RFC Title"- Create new Request for Comments document- Example:
/adr "Choose Database Technology"
/gen-er-diagram- Database schema diagrams/gen-arch-diagram- System architecture diagrams/gen-onboarding-diagram- Setup flow diagrams/gen-dependency-diagram- External service diagrams/gen-security-diagram- Security flow diagrams/gen-deployment-diagram- Infrastructure diagrams
/add-template TemplateName path/to/template.md- Add custom template/list-templates- Show available templates
/sync-docs- Sync all documentation/sync-doc filename.md- Sync specific document/sync-category category- Sync specific category (adr, architecture, etc.)
Works immediately with smart detection:
- Web APIs → API-focused architecture docs
- Frontend Applications → Component-based system diagrams
- Database Models → Detailed ER diagrams with relationships
- Any Framework → Framework-appropriate documentation
- ADRs: Nygard, MADR, Comprehensive, Lightweight
- Architecture: Google Style, Enterprise, Arc42
- Onboarding: Developer, Contributor, User
- Data Model: Simple, Comprehensive
Choose exactly what documentation you need:
# .cursor-init.yaml (optional customization)
documentation:
core:
architecture: true # System overview
onboarding: true # Developer setup guide
adr: true # Architecture decisions
data:
data_model: true # Database schema
database_ops: false # Performance & operations
data_security: false # Security policies
infrastructure:
deployment: false # CI/CD & infrastructure
dependencies: false # External services
security: false # Security flows
development:
rfc: false # Request for Comments
contributing: false # Contribution guides
api_docs: false # API documentationStartup/Small Team:
documentation:
core: { architecture: true, onboarding: true, adr: true }
data: { data_model: true }
development: { contributing: true }Enterprise/Large Team:
documentation:
core: { architecture: true, onboarding: true, adr: true }
data: { data_model: true, database_ops: true, data_security: true }
infrastructure: { deployment: true, dependencies: true, security: true }
development: { rfc: true, contributing: true, api_docs: true }Safe by Design:
- 🔒 Static Analysis Only - No code execution by default
- 🏖️ Sandboxed Operations - Isolated environment for advanced features
- ⏱️ Resource Limits - Timeouts and memory constraints
- 🔍 Transparent Operations - See exactly what's being analyzed
Enterprise Ready:
- ✅ MIT Licensed
- ✅ No external API calls
- ✅ Works offline
- ✅ No data collection
/add-template MyTemplate path/to/template.md
/list-templates # See all available templates/sync-docs # Update all documentation
/sync-category adr # Update only ADRsWe're building the future of developer documentation. Join us!
- 🐛 Found a bug? Open an issue
- 💡 Have an idea? Start a discussion
- 🔧 Want to contribute? Check our Contributing Guide
- 📝 Add templates for new frameworks (Vue, Angular, Spring Boot)
- 🎨 Create new documentation styles
- 🔧 Improve framework detection logic
- 📚 Write tutorials and examples
- 🏗️ 21 Built-in Templates across 6 document types
- 🎯 16 Slash Commands for instant documentation
- 🔧 Universal Framework Support via AI detection
- ⚡ 0 Dependencies for basic functionality
- 🛡️ 100% Static Analysis for security
MIT License - see LICENSE for details.
If this tool saved you time, give us a star! It helps other developers discover the project.
Built with ❤️ for developers who hate writing docs but love having them.