Download the PHP package karlost/digidocs without Composer
On this page you can find all versions of the php package karlost/digidocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download karlost/digidocs
More information about karlost/digidocs
Files in karlost/digidocs
Package digidocs
Short Description AI-powered Laravel documentation generator with dual documentation types (developer + user) and intelligent change analysis
License MIT
Homepage https://github.com/karlost/digidocs
Informations about the package digidocs
Digidocs - AI-Powered Laravel Documentation Generator
Digidocs is an advanced Laravel package that automatically generates comprehensive documentation using AI. It creates both developer documentation (technical API docs) and user documentation (end-user guides) with intelligent change analysis and real-time Git monitoring.
✨ Key Features
📚 Dual Documentation Types
- 👨💻 Developer Documentation - Technical API docs for code maintainers
- 👥 User Documentation - End-user guides for application users
- 🧠 Intelligent routing - Automatically determines which type to generate
🤖 AI-Powered Generation
- 🤖 Advanced AI models - Uses OpenAI/GPT-4, Claude, Gemini, and more
- 🧠 Intelligent change analysis - Separate agents for developer vs user impact
- 📊 Context-aware - Understands Laravel patterns and user workflows
🔄 Smart Change Detection
- 🎯 UserChangeAnalysisAgent - Analyzes UI/UX impact for user docs
- 🛠️ ChangeAnalysisAgent - Analyzes API changes for developer docs
- 📋 Documented parts tracking - Tracks which code parts are documented
- 🔄 Git commit monitoring - Processes only changed files
⚡ Advanced Features
- 👁️ Real-time watch mode - Continuous monitoring with automatic regeneration
- 📊 Semantic analysis - Distinguishes between public API and private changes
- 💾 SQLite tracking - Efficient tracking of changes, analyses and documentation
- 🛠️ NeuronAI architecture - Modular system with specialized Agents and Tools
- 🔍 Laravel context - Recognizes Controllers, Models, Blade templates, Routes
- 💰 Cost tracking - Detailed token usage and cost statistics
- 🎯 High efficiency - Skip rate up to 85% thanks to intelligent analysis
🚀 Installation
⚙️ Configuration
📋 Usage
�💻 Developer Documentation (Technical API Docs)
Available options:
--force
- Force regeneration even for unchanged files--dry-run
- Show what would be processed without generating--path=PATH
- Process specific paths (can be used multiple times)--stats
- Show documentation statistics--cost
- Show token usage and cost statistics--cleanup
- Clean database from non-existent files
Intelligent analysis:
- 🧠 ChangeAnalysisAgent decides whether to regenerate documentation
- ✅ Public API changes → Regenerates documentation
- ⏭️ Private changes/whitespace → Skips regeneration
- 📊 Tracks documented parts of code for more precise decisions
👥 User Documentation (End-User Guides)
Available options:
--force
- Force regeneration of all user documentation--dry-run
- Show what would be processed without generating--stats
- Show documentation statistics--cost
- Show token usage and cost statistics
User documentation features:
- 🎯 UserChangeAnalysisAgent - Analyzes changes from user perspective
- 🖥️ UI/UX focus - Prioritizes Blade templates, routes, and user-facing changes
- 📱 Application-level docs - Generates structured guides with sections
- 🔄 Smart regeneration - Only updates when user experience is affected
- 📊 Impact scoring - Rates changes by user impact (0-100)
- 📂 Section-based organization - Organizes content by user workflows
- 🔗 Cross-references - Links between related sections
👁️ Watch Mode - Real-time Git Commit Monitoring
Available options:
--interval=SECONDS
- Check interval in seconds (default: 5)--path=PATH
- Specific paths to watch (can be used multiple times)--code-only
- Generate only developer documentation--user-only
- Generate only user documentation
Watch mode features:
- 🔄 Real-time monitoring - Monitors Git commits continuously
- 🧠 Intelligent analysis - Separate agents for dev vs user docs
- 🎯 Smart filtering - Only processes relevant changes
- 🛑 Graceful shutdown - Ctrl+C for clean exit
- 📚 Unified processing - Both documentation types in one command
🤖 Supported AI Providers
Tested and verified:
- ✅ OpenAI GPT-4.1 Nano - Fully tested and optimized (recommended)
Supported but not extensively tested:
- 🔶 OpenAI - GPT-4o, GPT-4, GPT-3.5, O3, O4-mini
- 🔶 Anthropic - Claude 4, Claude 3.7, Claude 3.5, Claude 3
- 🔶 Gemini - Gemini 1.5 Pro/Flash, Gemini 2.0 Flash
- 🔶 Deepseek - Deepseek Chat/Coder
- 🔶 Mistral - Mistral Large/Medium/Small
- 🔶 Ollama - Local models (free)
Note: All testing was performed with GPT-4.1 Nano model. Other providers are supported through NeuronAI framework but may require additional configuration or testing.
Automatic pricing:
Model prices are configurable in config/digidocs/pricing.php
.
💡 Quick Start
🧠 Intelligent Analysis Examples
Developer documentation:
- ⏭️ Private changes → Skipped (no significant changes)
- ✅ Public API changes → Generated documentation
User documentation:
- ⏭️ Backend changes → Skipped (low user impact)
- ✅ UI/UX changes → Updated relevant sections
📊 Documentation Quality
👨💻 Developer Documentation
Generates comprehensive technical documentation with:
- File overview and its purpose
- Complete API documentation - all public methods and properties
- Laravel context - relationships, scopes, middleware, etc.
- Practical usage examples with working code
- Dependencies and relationships - clear integration points
👥 User Documentation
Creates user-friendly application guides with:
- Application overview - what the app does for users
- Feature sections - organized by user workflows
- Step-by-step guides - how to accomplish tasks
- Cross-referenced sections - linked content organization
- User-focused language - non-technical explanations
📁 Output Structure
Developer documentation:
User documentation:
📈 Performance & Testing
Proven efficiency:
- ⚡ 56.5% skip rate - Intelligent analysis avoids unnecessary regeneration
- 🎯 90.5% average confidence - High-quality analysis decisions
- 💰 Cost-effective - Only ~$0.26 for 350 API calls and 2M+ tokens
- 🚀 Real-time processing - Watch mode with instant Git commit detection
Comprehensive testing:
- ✅ 21 documented files across Models, Controllers, Services, Middleware
- ✅ Complex commits with multiple file types and changes
- ✅ Watch mode tested with real-time Git monitoring
- ✅ Both documentation types verified for quality and accuracy
- ✅ Cost tracking validated for precise token and pricing calculations
All versions of digidocs with dependencies
illuminate/support Version ^10.0|^11.0|^12.0
illuminate/database Version ^10.0|^11.0|^12.0
illuminate/contracts Version ^10.0|^11.0|^12.0
illuminate/console Version ^10.0|^11.0|^12.0
inspector-apm/neuron-ai Version ^1.0
czproject/git-php Version ^4.0
nikic/php-parser Version ^5.0