Download the PHP package innoraft/ai-readme-generator without Composer
On this page you can find all versions of the php package innoraft/ai-readme-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download innoraft/ai-readme-generator
More information about innoraft/ai-readme-generator
Files in innoraft/ai-readme-generator
Package ai-readme-generator
Short Description This package will generate a Readme.md file according to your codebase.
License MIT
Informations about the package ai-readme-generator
📘 Readme Generator
Innoraft Readme Generator is a command-line PHP utility that generates a Drupal-style README.md file for any Drupal module or PHP codebase using AI. It scans the provided module, extracts structured metadata, and produces a high-quality, standardized README automatically.
🚀 Features
- Generates a
README.mdfile in the module folder - Supports
.env-based configuration for flexible local/remote AI services - Can be executed from both the project root and within module folders
🧰 Requirements
- PHP 8.1 or higher
- Composer
- API key and endpoint for AI summarization (e.g., GroqCloud/OpenAI)
📦 Installation
Run this from the root of your Drupal project:
⚙️ Setup
Copy the example environment file and update it with your actual credentials.
✅ Usage
📍 From Project Root
This command scans the specified module and writes README.md inside it.
📂 Output
After running the command, you'll get a README.md file with:
- Module name
- Description
- Key features and functionality
- Dependency info
- Usage instructions (if derivable)
- Auto-generated AI summary
🤖 Behind the Scenes
- Codebase is scanned and structured data is extracted.
- Data is sent to an AI service configured via
.env. - AI returns a formatted README, which is saved in your module folder.
🛠 Development Notes
- If you are using this inside a Drupal module or sub-directory, ensure paths are resolved correctly.
- The binary path is defined in the
composer.jsonunder"bin": ["bin/readme-generator"].
📬 Contributing
Found a bug or want to enhance it? Feel free to open issues or submit PRs!
🧑💻 Authors
- Arun Sahijpal
- Kul Pratap Singh
📄 License
MIT License
All versions of ai-readme-generator with dependencies
symfony/console Version ^6.3 || ^7.0
symfony/yaml Version ^6.3 || ^7.0
symfony/http-client Version ^6.3 || ^7.0
openai-php/client Version ^0.10.3
nyholm/psr7 Version ^1.8
guzzlehttp/guzzle Version ^7.9
vlucas/phpdotenv Version ^5.6