# DocForge - Open Source AI Documentation Generator
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/downloads/)
[](https://openai.com/)
[](https://badge.fury.io/py/docforge-ai)
[](https://pepy.tech/project/docforge-ai)
**DocForge** is a powerful, self-contained AI-powered documentation generator that transforms simple project ideas into comprehensive, professional software documentation. Built with CrewAI and OpenAI, it generates enterprise-grade documents including project charters, requirements specifications, architecture documents, and more.
## 🚀 Quick Start
**Install from PyPI:**
```bash
# Using pip
pip install docforge-ai
# Using uv (faster)
uv pip install docforge-ai
```
**Get started in seconds:**
```bash
docforge-ai init
docforge-ai generate "AI-powered chatbot for customer service"
```
> **📦 Available on PyPI**: Install with `pip install docforge-ai` or `uv pip install docforge-ai`
## 🚀 Features
- **PRD-First Workflow**: Start with a Product Requirements Document including user stories, validate, then expand
- **AI-Powered Generation**: Uses advanced AI agents to create professional documentation
- **Multiple Document Types**: Generate 10+ different types of technical documents
- **Self-Contained**: No external database dependencies - uses local file storage
- **Easy Setup**: Simple installation and configuration with `.env` file
- **Professional Quality**: Enterprise-grade document templates and formatting
- **Document Revision**: Revise PRDs with additional specifications using AI
- **Contextual Generation**: Generate additional documents based on validated PRD content
- **Flexible Output**: Generate specific document types or complete document sets
- **Neat Organization**: Documents are stored in organized project directories
- **Interactive Setup**: Guided initialization with document type selection
## 📋 Supported Document Types
1. **Project Charter** - Executive-level project overview with business objectives, scope, and timeline
2. **Software Requirements Specification (SRS)** - Detailed functional and non-functional requirements with user stories
3. **System Architecture** - High-level system design with components, security, and scalability
4. **Low-Level Design** - Detailed technical design with API specifications and database schema
5. **Test Specification** - Comprehensive testing strategy with test cases and acceptance criteria
6. **Deployment Guide** - Step-by-step deployment and release procedures
7. **Operations Manual** - System operations, monitoring, and maintenance procedures
8. **Business Case** - ROI analysis and business justification for the project
9. **Market Requirements** - Market analysis and user requirements documentation
10. **Vision Brief** - Strategic vision and opportunity brief for stakeholders
## 🛠️ Installation
### Prerequisites
- Python 3.10 or higher
- OpenAI API key ([Get one here](https://platform.openai.com/api-keys))
### Install from PyPI (Recommended)
**Using pip:**
```bash
pip install docforge-ai
```
**Using uv (faster and more reliable):**
```bash
# Install uv if you don't have it
pip install uv
# Install docforge-ai
uv pip install docforge-ai
```
**Using conda:**
```bash
conda install -c conda-forge pip
pip install docforge-ai
```
### Install from Source (Development)
```bash
# Clone the repository
git clone https://github.com/Venkatesh188/docforge-ai.git
cd docforge-ai
# Install dependencies
pip install -r requirements.txt
# Initialize DocForge (creates .env file and shows available document types)
docforge-ai init
```
## 🎯 Getting Started
After installation, follow these steps:
1. **Initialize DocForge:**
```bash
docforge-ai init
```
This creates a `.env` file where you'll add your OpenAI API key.
2. **Add your OpenAI API key:**
```bash
# Edit the .env file
OPENAI_API_KEY=your_actual_openai_api_key_here
```
3. **Generate your first document:**
```bash
docforge-ai generate "AI-powered chatbot for customer service"
```
4. **Explore available commands:**
```bash
docforge-ai --help
docforge-ai list-docs
```
### Package Installation
```bash
# Install from source
pip install .
# Or install in development mode
pip install -e .
```
## ⚙️ Configuration
### Initial Setup
1. **Run initialization** to create the `.env` file:
```bash
docforge-ai init
```
2. **Edit the `.env` file** with your OpenAI API key:
```bash
# Required
OPENAI_API_KEY=your_actual_openai_api_key_here
# Optional (defaults shown)
OPENAI_MODEL=gpt-4o-mini
DOCFORGE_GENERATED_DOCS_PATH=generated-docs
```
3. **Get your OpenAI API key** from [OpenAI Platform](https://platform.openai.com/api-keys)
## 🚀 Quick Start
### Interactive Mode (Recommended for first-time users)
```bash
python start_docforge-ai.py
```
### Command Line Usage
#### PRD-First Workflow (Recommended)
The recommended approach is to start with a Product Requirements Document (PRD) that includes user stories, validate it, and then generate additional documents based on the validated PRD.
**Step 1: Generate a PRD**
```bash
# Generate a PRD with user stories
docforge-ai generate "AI-powered chatbot for customer service" --docs srs
```
**Step 2: Review and Optionally Revise the PRD**
```bash
# Review the generated PRD file, then optionally add more specifications
docforge-ai revise ai-powered-chatbot-for-customer-service -s "Add multi-language support and integration with Slack and Microsoft Teams"
```
**Step 3: Generate Additional Documents Based on Validated PRD**
```bash
# Generate architecture, testing, and deployment documents based on the PRD
docforge-ai continue ai-powered-chatbot-for-customer-service ARCH TEST DEPLOY
# Or generate specific documents
docforge-ai continue ai-powered-chatbot-for-customer-service ARCHITECTURE
docforge-ai continue ai-powered-chatbot-for-customer-service BUSINESS MARKET
```
#### Alternative: Generate Single Documents
```bash
# Generate individual documents (without PRD workflow)
docforge-ai generate "E-commerce platform for handmade crafts" --docs srs
docforge-ai generate "Mobile banking application" --docs architecture
```
#### Legacy: Generate Complete Documentation Set
```bash
# Generate all default documents at once
docforge-ai generate "E-commerce platform for handmade crafts"
docforge-ai generate "Mobile task management app" --docs project_charter,srs,architecture
```
#### List Available Document Types and Aliases
```bash
docforge-ai list-docs
```
This command shows all available document types and their quick aliases for single document generation.
### 🎯 Why Use PRD-First Workflow?
The PRD-first workflow offers several advantages:
1. **Validation Before Expansion**: Review and validate the core requirements and user stories before generating additional documents
2. **Consistency**: All subsequent documents are generated based on the same validated PRD, ensuring consistency across the documentation set
3. **Iterative Improvement**: Easily revise the PRD with additional specifications without regenerating all documents
4. **Cost Effective**: Generate only what you need - start with PRD, validate, then expand
5. **Better Quality**: Documents generated from a validated PRD tend to be more accurate and detailed
6. **User Story Foundation**: PRDs include comprehensive user stories that inform all other documents
**Document Type Aliases (use with --docs flag):**
- `srs` or `prd` → Software Requirements Specification
- `architecture` or `arch` or `hld` → System Architecture
- `low_level_design` or `lld` or `design` → Low-Level Design
- `test_specification` or `test` or `testing` → Test Specification
- `deployment_guide` or `deploy` or `deployment` → Deployment Guide
- `operations_manual` or `ops` or `operations` → Operations Manual
- `business_case` or `business` → Business Case
- `market_requirements` or `market` → Market Requirements
- `vision_brief` or `vision` → Vision Brief
- `project_charter` or `charter` or `project` → Project Charter
#### Check Project Status
```bash
docforge-ai status my-ecommerce-platform
```
#### List All Projects
```bash
docforge-ai list-projects
```
## 📁 Project Structure
```
docforge-ai/
├── docforge-ai.py # Main CLI interface
├── start_docforge-ai.py # Interactive startup script
├── docforge-ai/ # Package directory
│ ├── __init__.py
│ └── docforge-ai.py # Package main module
├── backend/ # Core application logic
│ └── app/
│ ├── core/ # Configuration and settings
│ │ └── simple_config.py
│ ├── models.py # Data models
│ └── services/ # Business logic services
│ ├── document_agents.py
│ ├── local_storage_service.py
│ └── openai_service.py
├── prompts/ # AI prompt templates
│ ├── charter.md
│ ├── requirements.md
│ ├── architecture.md
│ ├── design.md
│ ├── testing.md
│ ├── deployment.md
│ ├── operations.md
│ ├── business_case.md
│ ├── market_requirements.md
│ └── vision_brief.md
├── storage/ # Local data storage
│ ├── projects/ # Project metadata
│ ├── documents/ # Document metadata
│ └── generated-docs/ # Generated documentation
├── generated-docs/ # User-generated documentation
├── requirements.txt # Python dependencies
└── .env # Configuration file (created by init)
```
## 📖 Usage Examples
### Example 1: Complete Project Documentation
```bash
docforge-ai generate "AI-powered customer service chatbot" --context "React frontend, Node.js backend, PostgreSQL database"
```
### Example 2: Architecture-Focused Documentation
```bash
docforge-ai generate "Microservices e-commerce platform" --docs architecture,deployment_guide,operations_manual
```
### Example 3: Business-Focused Documentation
```bash
docforge-ai generate "SaaS project management tool" --docs business_case,market_requirements,vision_brief
```
### Example 4: Custom Project Name
```bash
docforge-ai generate "Build a mobile app" --name "MyAwesomeApp" --docs srs,architecture
```
## 📂 Document Organization
DocForge organizes your generated documents neatly:
```
generated-docs/
└── your-project-name/
├── README.md # Project overview and index
├── 01_project_charter.md # Project charter
├── 02_srs.md # Software requirements
├── 03_architecture.md # System architecture
├── 04_test_specification.md # Test specification
└── ... # Additional documents
```
Each project gets its own directory with:
- **Sequential numbering** for easy navigation
- **README.md** with project overview and document index
- **Clean markdown files** ready for use
- **Metadata tracking** in the storage system
## 🎯 Document Type Selection
When you run `docforge-ai init`, DocForge will show you all available document types:
```
📋 Available Document Types (10):
1. Project Charter
Type: project_charter
Description: Executive-level project overview with business objectives, scope, and timeline
2. Software Requirements Specification
Type: srs
Description: Detailed functional and non-functional requirements with user stories
3. System Architecture
Type: architecture
Description: High-level system design with components, security, and scalability
...
```
You can then generate specific documents using the type names:
```bash
docforge-ai generate "My project" --docs project_charter,srs,architecture
```
## 🔧 Advanced Configuration
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `OPENAI_API_KEY` | OpenAI API key (required) | - |
| `OPENAI_MODEL` | OpenAI model to use | `gpt-4o-mini` |
| `DOCFORGE_GENERATED_DOCS_PATH` | Generated docs directory | `generated-docs` |
| `DOCFORGE_MAX_TOKENS` | Max tokens per document | `3000` |
| `DOCFORGE_DEFAULT_DOCS` | Default document types | `project_charter,srs,architecture,test_specification` |
### Custom Document Types
You can customize the document generation by modifying the prompt templates in the `prompts/` directory.
### Storage Configuration
DocForge uses local file storage by default. All data is stored in:
- `storage/projects/` - Project metadata (JSON files) - Created automatically when first generating documents
- `storage/documents/` - Document metadata (JSON files) - Created automatically when first generating documents
- `generated-docs/` - Generated markdown files organized by project - Created during initialization
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
### Development Setup
```bash
# Clone and setup development environment
git clone https://github.com/docforge-ai-community/docforge-ai-opensource.git
cd docforge-ai-opensource
# Install in development mode
pip install -e .
# Install development dependencies
pip install -e ".[dev]"
# Run tests
pytest
```
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🆘 Support
- **Documentation**: [Wiki](https://github.com/docforge-ai-community/docforge-ai-opensource/wiki)
- **Issues**: [GitHub Issues](https://github.com/docforge-ai-community/docforge-ai-opensource/issues)
- **Discussions**: [GitHub Discussions](https://github.com/docforge-ai-community/docforge-ai-opensource/discussions)
## 🙏 Acknowledgments
- Built with [CrewAI](https://github.com/joaomdmoura/crewAI) for AI agent orchestration
- Powered by [OpenAI](https://openai.com/) for document generation
- Inspired by the need for better software documentation practices
#crewai>=0.141.0,<1.0.0
---
**Made with ❤️ by the DocForge Community**
Raw data
{
"_id": null,
"home_page": "https://github.com/Venkatesh188/docforge",
"name": "docforge-ai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "DocForge Community <community@docforge.dev>",
"keywords": "documentation, ai, generator, automation, software-development, project-management, openai, markdown",
"author": "DocForge Community",
"author_email": "DocForge Community <community@docforge.dev>",
"download_url": "https://files.pythonhosted.org/packages/50/6d/140a067e8059449bc131fca1a3afe1f28b770b1b57722e01f691a37b84fe/docforge_ai-2.0.3.tar.gz",
"platform": null,
"description": "# DocForge - Open Source AI Documentation Generator\r\n\r\n[](https://opensource.org/licenses/MIT)\r\n[](https://www.python.org/downloads/)\r\n[](https://openai.com/)\r\n[](https://badge.fury.io/py/docforge-ai)\r\n[](https://pepy.tech/project/docforge-ai)\r\n\r\n**DocForge** is a powerful, self-contained AI-powered documentation generator that transforms simple project ideas into comprehensive, professional software documentation. Built with CrewAI and OpenAI, it generates enterprise-grade documents including project charters, requirements specifications, architecture documents, and more.\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n**Install from PyPI:**\r\n```bash\r\n# Using pip\r\npip install docforge-ai\r\n\r\n# Using uv (faster)\r\nuv pip install docforge-ai\r\n```\r\n\r\n**Get started in seconds:**\r\n```bash\r\ndocforge-ai init\r\ndocforge-ai generate \"AI-powered chatbot for customer service\"\r\n```\r\n\r\n> **\ud83d\udce6 Available on PyPI**: Install with `pip install docforge-ai` or `uv pip install docforge-ai`\r\n\r\n## \ud83d\ude80 Features\r\n\r\n- **PRD-First Workflow**: Start with a Product Requirements Document including user stories, validate, then expand\r\n- **AI-Powered Generation**: Uses advanced AI agents to create professional documentation\r\n- **Multiple Document Types**: Generate 10+ different types of technical documents\r\n- **Self-Contained**: No external database dependencies - uses local file storage\r\n- **Easy Setup**: Simple installation and configuration with `.env` file\r\n- **Professional Quality**: Enterprise-grade document templates and formatting\r\n- **Document Revision**: Revise PRDs with additional specifications using AI\r\n- **Contextual Generation**: Generate additional documents based on validated PRD content\r\n- **Flexible Output**: Generate specific document types or complete document sets\r\n- **Neat Organization**: Documents are stored in organized project directories\r\n- **Interactive Setup**: Guided initialization with document type selection\r\n\r\n## \ud83d\udccb Supported Document Types\r\n\r\n1. **Project Charter** - Executive-level project overview with business objectives, scope, and timeline\r\n2. **Software Requirements Specification (SRS)** - Detailed functional and non-functional requirements with user stories\r\n3. **System Architecture** - High-level system design with components, security, and scalability\r\n4. **Low-Level Design** - Detailed technical design with API specifications and database schema\r\n5. **Test Specification** - Comprehensive testing strategy with test cases and acceptance criteria\r\n6. **Deployment Guide** - Step-by-step deployment and release procedures\r\n7. **Operations Manual** - System operations, monitoring, and maintenance procedures\r\n8. **Business Case** - ROI analysis and business justification for the project\r\n9. **Market Requirements** - Market analysis and user requirements documentation\r\n10. **Vision Brief** - Strategic vision and opportunity brief for stakeholders\r\n\r\n## \ud83d\udee0\ufe0f Installation\r\n\r\n### Prerequisites\r\n- Python 3.10 or higher\r\n- OpenAI API key ([Get one here](https://platform.openai.com/api-keys))\r\n\r\n### Install from PyPI (Recommended)\r\n\r\n**Using pip:**\r\n```bash\r\npip install docforge-ai\r\n```\r\n\r\n**Using uv (faster and more reliable):**\r\n```bash\r\n# Install uv if you don't have it\r\npip install uv\r\n\r\n# Install docforge-ai\r\nuv pip install docforge-ai\r\n```\r\n\r\n**Using conda:**\r\n```bash\r\nconda install -c conda-forge pip\r\npip install docforge-ai\r\n```\r\n\r\n### Install from Source (Development)\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/Venkatesh188/docforge-ai.git\r\ncd docforge-ai\r\n\r\n# Install dependencies\r\npip install -r requirements.txt\r\n\r\n# Initialize DocForge (creates .env file and shows available document types)\r\ndocforge-ai init\r\n```\r\n\r\n## \ud83c\udfaf Getting Started\r\n\r\nAfter installation, follow these steps:\r\n\r\n1. **Initialize DocForge:**\r\n ```bash\r\n docforge-ai init\r\n ```\r\n This creates a `.env` file where you'll add your OpenAI API key.\r\n\r\n2. **Add your OpenAI API key:**\r\n ```bash\r\n # Edit the .env file\r\n OPENAI_API_KEY=your_actual_openai_api_key_here\r\n ```\r\n\r\n3. **Generate your first document:**\r\n ```bash\r\n docforge-ai generate \"AI-powered chatbot for customer service\"\r\n ```\r\n\r\n4. **Explore available commands:**\r\n ```bash\r\n docforge-ai --help\r\n docforge-ai list-docs\r\n ```\r\n\r\n### Package Installation\r\n```bash\r\n# Install from source\r\npip install .\r\n\r\n# Or install in development mode\r\npip install -e .\r\n```\r\n\r\n## \u2699\ufe0f Configuration\r\n\r\n### Initial Setup\r\n1. **Run initialization** to create the `.env` file:\r\n```bash\r\ndocforge-ai init\r\n```\r\n\r\n2. **Edit the `.env` file** with your OpenAI API key:\r\n```bash\r\n# Required\r\nOPENAI_API_KEY=your_actual_openai_api_key_here\r\n\r\n# Optional (defaults shown)\r\nOPENAI_MODEL=gpt-4o-mini\r\nDOCFORGE_GENERATED_DOCS_PATH=generated-docs\r\n```\r\n\r\n3. **Get your OpenAI API key** from [OpenAI Platform](https://platform.openai.com/api-keys)\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### Interactive Mode (Recommended for first-time users)\r\n```bash\r\npython start_docforge-ai.py\r\n```\r\n\r\n### Command Line Usage\r\n\r\n#### PRD-First Workflow (Recommended)\r\n\r\nThe recommended approach is to start with a Product Requirements Document (PRD) that includes user stories, validate it, and then generate additional documents based on the validated PRD.\r\n\r\n**Step 1: Generate a PRD**\r\n```bash\r\n# Generate a PRD with user stories\r\ndocforge-ai generate \"AI-powered chatbot for customer service\" --docs srs\r\n```\r\n\r\n**Step 2: Review and Optionally Revise the PRD**\r\n```bash\r\n# Review the generated PRD file, then optionally add more specifications\r\ndocforge-ai revise ai-powered-chatbot-for-customer-service -s \"Add multi-language support and integration with Slack and Microsoft Teams\"\r\n```\r\n\r\n**Step 3: Generate Additional Documents Based on Validated PRD**\r\n```bash\r\n# Generate architecture, testing, and deployment documents based on the PRD\r\ndocforge-ai continue ai-powered-chatbot-for-customer-service ARCH TEST DEPLOY\r\n\r\n# Or generate specific documents\r\ndocforge-ai continue ai-powered-chatbot-for-customer-service ARCHITECTURE\r\ndocforge-ai continue ai-powered-chatbot-for-customer-service BUSINESS MARKET\r\n```\r\n\r\n#### Alternative: Generate Single Documents\r\n```bash\r\n# Generate individual documents (without PRD workflow)\r\ndocforge-ai generate \"E-commerce platform for handmade crafts\" --docs srs\r\ndocforge-ai generate \"Mobile banking application\" --docs architecture\r\n```\r\n\r\n#### Legacy: Generate Complete Documentation Set\r\n```bash\r\n# Generate all default documents at once\r\ndocforge-ai generate \"E-commerce platform for handmade crafts\"\r\ndocforge-ai generate \"Mobile task management app\" --docs project_charter,srs,architecture\r\n```\r\n\r\n#### List Available Document Types and Aliases\r\n```bash\r\ndocforge-ai list-docs\r\n```\r\n\r\nThis command shows all available document types and their quick aliases for single document generation.\r\n\r\n### \ud83c\udfaf Why Use PRD-First Workflow?\r\n\r\nThe PRD-first workflow offers several advantages:\r\n\r\n1. **Validation Before Expansion**: Review and validate the core requirements and user stories before generating additional documents\r\n2. **Consistency**: All subsequent documents are generated based on the same validated PRD, ensuring consistency across the documentation set\r\n3. **Iterative Improvement**: Easily revise the PRD with additional specifications without regenerating all documents\r\n4. **Cost Effective**: Generate only what you need - start with PRD, validate, then expand\r\n5. **Better Quality**: Documents generated from a validated PRD tend to be more accurate and detailed\r\n6. **User Story Foundation**: PRDs include comprehensive user stories that inform all other documents\r\n\r\n**Document Type Aliases (use with --docs flag):**\r\n- `srs` or `prd` \u2192 Software Requirements Specification\r\n- `architecture` or `arch` or `hld` \u2192 System Architecture\r\n- `low_level_design` or `lld` or `design` \u2192 Low-Level Design\r\n- `test_specification` or `test` or `testing` \u2192 Test Specification\r\n- `deployment_guide` or `deploy` or `deployment` \u2192 Deployment Guide\r\n- `operations_manual` or `ops` or `operations` \u2192 Operations Manual\r\n- `business_case` or `business` \u2192 Business Case\r\n- `market_requirements` or `market` \u2192 Market Requirements\r\n- `vision_brief` or `vision` \u2192 Vision Brief\r\n- `project_charter` or `charter` or `project` \u2192 Project Charter\r\n\r\n#### Check Project Status\r\n```bash\r\ndocforge-ai status my-ecommerce-platform\r\n```\r\n\r\n#### List All Projects\r\n```bash\r\ndocforge-ai list-projects\r\n```\r\n\r\n## \ud83d\udcc1 Project Structure\r\n\r\n```\r\ndocforge-ai/\r\n\u251c\u2500\u2500 docforge-ai.py # Main CLI interface\r\n\u251c\u2500\u2500 start_docforge-ai.py # Interactive startup script\r\n\u251c\u2500\u2500 docforge-ai/ # Package directory\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u2514\u2500\u2500 docforge-ai.py # Package main module\r\n\u251c\u2500\u2500 backend/ # Core application logic\r\n\u2502 \u2514\u2500\u2500 app/\r\n\u2502 \u251c\u2500\u2500 core/ # Configuration and settings\r\n\u2502 \u2502 \u2514\u2500\u2500 simple_config.py\r\n\u2502 \u251c\u2500\u2500 models.py # Data models\r\n\u2502 \u2514\u2500\u2500 services/ # Business logic services\r\n\u2502 \u251c\u2500\u2500 document_agents.py\r\n\u2502 \u251c\u2500\u2500 local_storage_service.py\r\n\u2502 \u2514\u2500\u2500 openai_service.py\r\n\u251c\u2500\u2500 prompts/ # AI prompt templates\r\n\u2502 \u251c\u2500\u2500 charter.md\r\n\u2502 \u251c\u2500\u2500 requirements.md\r\n\u2502 \u251c\u2500\u2500 architecture.md\r\n\u2502 \u251c\u2500\u2500 design.md\r\n\u2502 \u251c\u2500\u2500 testing.md\r\n\u2502 \u251c\u2500\u2500 deployment.md\r\n\u2502 \u251c\u2500\u2500 operations.md\r\n\u2502 \u251c\u2500\u2500 business_case.md\r\n\u2502 \u251c\u2500\u2500 market_requirements.md\r\n\u2502 \u2514\u2500\u2500 vision_brief.md\r\n\u251c\u2500\u2500 storage/ # Local data storage\r\n\u2502 \u251c\u2500\u2500 projects/ # Project metadata\r\n\u2502 \u251c\u2500\u2500 documents/ # Document metadata\r\n\u2502 \u2514\u2500\u2500 generated-docs/ # Generated documentation\r\n\u251c\u2500\u2500 generated-docs/ # User-generated documentation\r\n\u251c\u2500\u2500 requirements.txt # Python dependencies\r\n\u2514\u2500\u2500 .env # Configuration file (created by init)\r\n```\r\n\r\n## \ud83d\udcd6 Usage Examples\r\n\r\n### Example 1: Complete Project Documentation\r\n```bash\r\ndocforge-ai generate \"AI-powered customer service chatbot\" --context \"React frontend, Node.js backend, PostgreSQL database\"\r\n```\r\n\r\n### Example 2: Architecture-Focused Documentation\r\n```bash\r\ndocforge-ai generate \"Microservices e-commerce platform\" --docs architecture,deployment_guide,operations_manual\r\n```\r\n\r\n### Example 3: Business-Focused Documentation\r\n```bash\r\ndocforge-ai generate \"SaaS project management tool\" --docs business_case,market_requirements,vision_brief\r\n```\r\n\r\n### Example 4: Custom Project Name\r\n```bash\r\ndocforge-ai generate \"Build a mobile app\" --name \"MyAwesomeApp\" --docs srs,architecture\r\n```\r\n\r\n## \ud83d\udcc2 Document Organization\r\n\r\nDocForge organizes your generated documents neatly:\r\n\r\n```\r\ngenerated-docs/\r\n\u2514\u2500\u2500 your-project-name/\r\n \u251c\u2500\u2500 README.md # Project overview and index\r\n \u251c\u2500\u2500 01_project_charter.md # Project charter\r\n \u251c\u2500\u2500 02_srs.md # Software requirements\r\n \u251c\u2500\u2500 03_architecture.md # System architecture\r\n \u251c\u2500\u2500 04_test_specification.md # Test specification\r\n \u2514\u2500\u2500 ... # Additional documents\r\n```\r\n\r\nEach project gets its own directory with:\r\n- **Sequential numbering** for easy navigation\r\n- **README.md** with project overview and document index\r\n- **Clean markdown files** ready for use\r\n- **Metadata tracking** in the storage system\r\n\r\n## \ud83c\udfaf Document Type Selection\r\n\r\nWhen you run `docforge-ai init`, DocForge will show you all available document types:\r\n\r\n```\r\n\ud83d\udccb Available Document Types (10):\r\n 1. Project Charter\r\n Type: project_charter\r\n Description: Executive-level project overview with business objectives, scope, and timeline\r\n\r\n 2. Software Requirements Specification\r\n Type: srs\r\n Description: Detailed functional and non-functional requirements with user stories\r\n\r\n 3. System Architecture\r\n Type: architecture\r\n Description: High-level system design with components, security, and scalability\r\n...\r\n```\r\n\r\nYou can then generate specific documents using the type names:\r\n```bash\r\ndocforge-ai generate \"My project\" --docs project_charter,srs,architecture\r\n```\r\n\r\n## \ud83d\udd27 Advanced Configuration\r\n\r\n### Environment Variables\r\n| Variable | Description | Default |\r\n|----------|-------------|---------|\r\n| `OPENAI_API_KEY` | OpenAI API key (required) | - |\r\n| `OPENAI_MODEL` | OpenAI model to use | `gpt-4o-mini` |\r\n| `DOCFORGE_GENERATED_DOCS_PATH` | Generated docs directory | `generated-docs` |\r\n| `DOCFORGE_MAX_TOKENS` | Max tokens per document | `3000` |\r\n| `DOCFORGE_DEFAULT_DOCS` | Default document types | `project_charter,srs,architecture,test_specification` |\r\n\r\n### Custom Document Types\r\nYou can customize the document generation by modifying the prompt templates in the `prompts/` directory.\r\n\r\n### Storage Configuration\r\nDocForge uses local file storage by default. All data is stored in:\r\n- `storage/projects/` - Project metadata (JSON files) - Created automatically when first generating documents\r\n- `storage/documents/` - Document metadata (JSON files) - Created automatically when first generating documents\r\n- `generated-docs/` - Generated markdown files organized by project - Created during initialization\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\r\n\r\n### Development Setup\r\n```bash\r\n# Clone and setup development environment\r\ngit clone https://github.com/docforge-ai-community/docforge-ai-opensource.git\r\ncd docforge-ai-opensource\r\n\r\n# Install in development mode\r\npip install -e .\r\n\r\n# Install development dependencies\r\npip install -e \".[dev]\"\r\n\r\n# Run tests\r\npytest\r\n```\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83c\udd98 Support\r\n\r\n- **Documentation**: [Wiki](https://github.com/docforge-ai-community/docforge-ai-opensource/wiki)\r\n- **Issues**: [GitHub Issues](https://github.com/docforge-ai-community/docforge-ai-opensource/issues)\r\n- **Discussions**: [GitHub Discussions](https://github.com/docforge-ai-community/docforge-ai-opensource/discussions)\r\n\r\n## \ud83d\ude4f Acknowledgments\r\n\r\n- Built with [CrewAI](https://github.com/joaomdmoura/crewAI) for AI agent orchestration\r\n- Powered by [OpenAI](https://openai.com/) for document generation\r\n- Inspired by the need for better software documentation practices\r\n\r\n #crewai>=0.141.0,<1.0.0\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by the DocForge Community**\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Self-contained AI-powered documentation generator",
"version": "2.0.3",
"project_urls": {
"Bug Reports": "https://github.com/Venkatesh188/docforge/issues",
"Documentation": "https://github.com/Venkatesh188/docforge/wiki",
"Feature Requests": "https://github.com/Venkatesh188/docforge/issues/new?template=feature_request.yml",
"Homepage": "https://github.com/Venkatesh188/docforge",
"PyPI": "https://pypi.org/project/docforge-ai/",
"Source": "https://github.com/Venkatesh188/docforge"
},
"split_keywords": [
"documentation",
" ai",
" generator",
" automation",
" software-development",
" project-management",
" openai",
" markdown"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "13e2540a82a50626f858270f92ffa8c6309a72aafda89863e7f4d8c8b1978699",
"md5": "973cd92f20937bc8ed152d7db4417396",
"sha256": "99c5332367cd8fb1b13dd27cad1286564a54bef68359a58933b4a538f434d7f4"
},
"downloads": -1,
"filename": "docforge_ai-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "973cd92f20937bc8ed152d7db4417396",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 63918,
"upload_time": "2025-09-04T15:16:58",
"upload_time_iso_8601": "2025-09-04T15:16:58.247003Z",
"url": "https://files.pythonhosted.org/packages/13/e2/540a82a50626f858270f92ffa8c6309a72aafda89863e7f4d8c8b1978699/docforge_ai-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "506d140a067e8059449bc131fca1a3afe1f28b770b1b57722e01f691a37b84fe",
"md5": "4d538ff9efe8d1cf3a80bc8240443755",
"sha256": "8f842f49252900c70987b0503e0da89a06b48fdb1a18258172a54c2d49480e2b"
},
"downloads": -1,
"filename": "docforge_ai-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "4d538ff9efe8d1cf3a80bc8240443755",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 118630,
"upload_time": "2025-09-04T15:16:59",
"upload_time_iso_8601": "2025-09-04T15:16:59.534912Z",
"url": "https://files.pythonhosted.org/packages/50/6d/140a067e8059449bc131fca1a3afe1f28b770b1b57722e01f691a37b84fe/docforge_ai-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 15:16:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Venkatesh188",
"github_project": "docforge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "openai",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"1.0.0"
]
]
},
{
"name": "tiktoken",
"specs": [
[
">=",
"0.6.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.6.0"
]
]
},
{
"name": "pydantic-settings",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"6.0.0"
]
]
},
{
"name": "python-slugify",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "crewai",
"specs": [
[
">=",
"0.141.0"
]
]
},
{
"name": "httpx",
"specs": [
[
">=",
"0.24.0"
]
]
}
],
"lcname": "docforge-ai"
}
JSON
