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
- ๐ Universal Language Support - Any ISO language code (cs-CZ, ja-JP, ar-SA, zh-CN, etc.)
- ๐๏ธ 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
๐ Language Configuration
DigiDocs supports any ISO language code without code modifications:
Supported examples:
cs-CZ(Czech),en-US(English),de-DE(German)ja-JP(Japanese),ko-KR(Korean),zh-CN(Chinese)ar-SA(Arabic),hi-IN(Hindi),th-TH(Thai)pt-BR(Portuguese Brazil),es-MX(Spanish Mexico)- Any ISO 639-1 + ISO 3166-1 combination!
AI automatically recognizes and generates documentation in the specified language.
๐ 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:
--lang=ISO_CODE- Generate in specific language (e.g.,--lang=ja-JP)--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
Language examples:
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
๐ All Documentation (Combined Generation)
Available options:
--lang=ISO_CODE- Generate user docs in specific language (e.g.,--lang=pl-PL)--code-only- Generate only developer documentation--user-only- Generate only user documentation--all- Process all files for code documentation (not just Git changes)--force- Force regeneration of all documentation--path=PATH- Specific paths to process for code docs
Examples:
๐๏ธ 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
๐ Changelog
๐ v0.3.0 - Universal Language Support (2025-05-29)
๐ New Features:
- ๐ Universal ISO Language Support - Any ISO language code now supported (cs-CZ, ja-JP, ar-SA, zh-CN, etc.)
- ๐ New
alldocsCommand - Combined generation of both developer and user documentation - ๐ค AI-Powered Language Detection - AI automatically recognizes and generates in specified language
- ๐ง Simplified Configuration - No hardcoded languages, pure config-based language management
โจ Improvements:
- ๐งน Removed 70+ hardcoded languages from PHP code - now config-only
- ๐ Enhanced Language Instructions - Simplified AI prompts for better language recognition
- ๐ ๏ธ Fixed Memory System - Added missing
remember()andsearch()methods - ๐ Updated Cross-Reference Manager - Dynamic language support across all agents
๐งช Testing:
- โ Comprehensive Multi-Language Testing - Czech, English, and Polish fully tested
- โ Memory System Validation - SQLite database and vector storage verified
- โ 17 Generated Documents - 5 code docs + 12 user docs across multiple languages
- โ Zero-Config Language Addition - New languages work instantly without code changes
๐ Examples of Supported Languages:
- European: cs-CZ (Czech), en-US (English), de-DE (German), fr-FR (French)
- Asian: ja-JP (Japanese), ko-KR (Korean), zh-CN (Chinese), hi-IN (Hindi)
- Middle East: ar-SA (Arabic), he-IL (Hebrew), fa-IR (Persian)
- African: sw-KE (Swahili), am-ET (Amharic), zu-ZA (Zulu)
- And many more - any ISO 639-1 + ISO 3166-1 combination!
v0.2.0 - User Documentation & Advanced Analysis (2025-05-27)
- Added UserDocumentationOrchestrator with complete user-focused documentation generation
- Implemented UserChangeAnalysisAgent for user-impact analysis
- Added comprehensive testing with 100% success rate across 24 test scenarios
- Enhanced memory systems with RAG implementation
v0.1.0 - Initial Release (2025-05-25)
- Core DigiDocs functionality with AI-powered documentation generation
- Developer documentation with intelligent change analysis
- Git commit monitoring and real-time watch mode
- Cost tracking and performance optimization
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