Docudoodle is a PHP documentation generator package for Laravel that analyzes your codebase and creates documentation using your AI of choice. Docudoodle helps you understand your codebase better and can help document legacy or existing codebases you've just started working with.
Once you've installed this package, you can generate the documentation using the package's Artisan command. Once completed, the documentation will be available in the documentation/ folder of your project:
php artisan docudoodle:generate
You can use the model of your choice, with the project offering OpenAI, Claude, Gemini, and Ollama configuration options. Here's the package's configuration options at the time of writing:
return [
'openai_api_key' => env('OPENAI_API_KEY', ''),
'claude_api_key' => env('CLAUDE_API_KEY', ''),
'default_model' => env('DOCUDOODLE_MODEL', 'gpt-4o-mini'),
'max_tokens' => env('DOCUDOODLE_MAX_TOKENS', 10000),
'default_extensions' => ['php', 'yaml', 'yml'],
'default_skip_dirs' => ['vendor/', 'node_modules/', 'tests/', 'cache/'],
'ollama_host' => env('OLLAMA_HOST', 'localhost'),
'ollama_port' => env('OLLAMA_PORT', '11434'),
'gemini_api_key' => env('GEMINI_API_KEY', ''),
'default_api_provider' => env('DOCUDOODLE_API_PROVIDER', 'openai'),
];
Main Features
- Automatic Documentation Generation: Effortlessly generates documentation for PHP files by analyzing their content.
- Flexible AI Integration: Choose between OpenAI's powerful cloud API, Claude API, Google's Gemini API, or run locally with Ollama models for complete privacy.
- Ollama Support: Generate documentation completely offline using your own local Ollama models - perfect for private codebases or when you need to work without an internet connection.
- Customizable: Easily configure source directories, output folders, and other settings to match your workflow.
- Command-Line Interface: Includes a simple command-line script for quick documentation generation.
You can learn more about this package, get full installation instructions, and view the source code on GitHub. The package repository has a few examples so you can preview what to expect in the final documentation.
