PHPackages                             innoraft/ai-readme-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. innoraft/ai-readme-generator

ActiveLibrary

innoraft/ai-readme-generator
============================

This package will generate a Readme.md file according to your codebase.

v1.1.0(1y ago)02.6k↓17.4%MITPHPPHP ^8.1

Since Apr 28Pushed 1y ago2 watchersCompare

[ Source](https://github.com/innoraft/AI-Readme-Generator)[ Packagist](https://packagist.org/packages/innoraft/ai-readme-generator)[ RSS](/packages/innoraft-ai-readme-generator/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (7)Versions (3)Used By (0)

📘 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
----------

[](#-features)

- Generates a `README.md` file 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
--------------

[](#-requirements)

- PHP 8.1 or higher
- Composer
- API key and endpoint for AI summarization (e.g., GroqCloud/OpenAI)

---

📦 Installation
--------------

[](#-installation)

Run this from the **root of your Drupal project**:

```
composer require innoraft/readme-generator --dev
```

---

⚙️ Setup
--------

[](#️-setup)

Copy the example environment file and update it with your actual credentials.

✅ Usage
-------

[](#-usage)

### 📍 From Project Root

[](#-from-project-root)

```
vendor/bin/readme-generator web/modules/contrib/MODULE_NAME
```

This command scans the specified module and writes `README.md` inside it.

---

📂 Output
--------

[](#-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
-------------------

[](#-behind-the-scenes)

1. Codebase is scanned and structured data is extracted.
2. Data is sent to an AI service configured via `.env`.
3. AI returns a formatted README, which is saved in your module folder.

---

🛠 Development Notes
-------------------

[](#-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.json` under `"bin": ["bin/readme-generator"]`.

---

📬 Contributing
--------------

[](#-contributing)

Found a bug or want to enhance it? Feel free to open issues or submit PRs!

---

🧑‍💻 Authors
-----------

[](#‍-authors)

- [Arun Sahijpal](mailto:arunsahijpal111@gmail.com)
- [Kul Pratap Singh](mailto:kulpratap98@gmail.com)

---

📄 License
---------

[](#-license)

MIT License

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance48

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

385d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0b2cea9755d8199ebb57940041be046021a57b6811a89cb81c02a4f659425f60?d=identicon)[Arun Sahijpal](/maintainers/Arun%20Sahijpal)

![](https://www.gravatar.com/avatar/bfc83a66d10dab529cf966d0e7fbdcd2d0bb098fb9b3b7602adde75b329161a6?d=identicon)[Kul Pratap Singh](/maintainers/Kul%20Pratap%20Singh)

---

Top Contributors

[![arunsahijpal](https://avatars.githubusercontent.com/u/158024887?v=4)](https://github.com/arunsahijpal "arunsahijpal (3 commits)")

### Embed Badge

![Health badge](/badges/innoraft-ai-readme-generator/health.svg)

```
[![Health](https://phpackages.com/badges/innoraft-ai-readme-generator/health.svg)](https://phpackages.com/packages/innoraft-ai-readme-generator)
```

###  Alternatives

[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[laravel/vapor-cli

The Laravel Vapor CLI

31310.7M8](/packages/laravel-vapor-cli)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)