readmegen-cli 🛠️📄 — AI-Powered README Generator
readmegen-cli is a smart command-line tool that uses Google Gemini AI to auto-generate clean, professional, and detailed README.md files based on your project's structure, dependencies, and content.
✨ Features
- 📂 Analyzes your local project files for key data
- 🤖 Uses Gemini AI (1.5 / 2.5) for rich README generation
- 📌 Detects languages, dependencies, config, tests, and docs
- 💬 Accepts custom prompts to tailor output
- 💾 Automatically backs up old READMEs (unless
--overwrite) - 🧠 Summarizes project insights before generation
📦 Installation
Install from PyPI:
pip install readmegen-cli
Or install locally for development:
git clone https://github.com/inevitablegs/readmegen-cli
cd readmegen-cli
pip install .
🔐 Setup: API Key Required
You must set your Gemini API key to use this tool:
Option 1: .env File
Create a .env in your project or home directory:
GEMINI_API_KEY=your_google_gemini_api_key
Get your key here: https://makersuite.google.com/app/apikey
Option 2: System Environment Variable
export GEMINI_API_KEY=your_key_here # Linux/Mac
$env:GEMINI_API_KEY="your_key_here" # PowerShell
🚀 Usage
Basic
readmegen-cli . "your_key_here"
✅ Generates a README.md in the current project folder.
With Custom Instructions
readmegen-cli . --prompt "Add badges and a quickstart section"
Save to Custom File
readmegen-cli . --output CUSTOM_README.md
Overwrite Without Backup
readmegen-cli . --overwrite
🧠 What It Does
- Detects: languages, file counts, dependencies, key config files
- Prepares AI prompt with project insights
- Sends to Gemini 2.5 Flash model
- Outputs a fully structured Markdown README
📁 Project Structure
readmegen-cli/
├── readmegen_core/
│ ├── cli.py
│ ├── generate.py
│ ├── local_inspector.py
├── LICENSE
├── README.md
├── setup.py
├── setup.cfg
├── pyproject.toml
└── .github/
└── workflows/publish.yml
🛠 Tech Stack
| Technology | Purpose |
|---|---|
| Python 3.7+ | CLI engine |
| argparse | Command-line parsing |
| dotenv | Load .env API key |
| google-generativeai | Connect to Gemini models |
| setuptools/wheel | Packaging |
🔁 GitHub Actions (CI/CD)
Auto-publishing to PyPI is supported using .github/workflows/publish.yml triggered on releases.
🤝 Contributing
PRs and issues welcome! Improve prompts, templates, or features.
📜 License
MIT License © 2025 Ganesh Sonawane
📦 Links
- 🔗 GitHub: inevitablegs/readmegen-cli
- 📦 PyPI: readmegen-cli on PyPI
- 🧠 Gemini API: https://makersuite.google.com/app/apikey
Metadata
Release files for readmegen-cli 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| readmegen_cli-0.1.4.tar.gz | 8.1 kB | Without provenance | Details for readmegen_cli-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| readmegen_cli-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for readmegen_cli-0.1.4-py3-none-any.whl |
Total release size: 17.0 kB
Release files / readmegen_cli-0.1.4.tar.gz
| Download URL | readmegen_cli-0.1.4.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
464398d2eb6231bbb96159e4b5313319a746232bcec62b003dec2f3763f89522
|
|
BLAKE2b-256 checksum How to use checksums |
0a3548ef62bbc8a71aa415050cc68463954cd31ee9de83a3fe16062d84cf8568
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.5
|
Release files / readmegen_cli-0.1.4-py3-none-any.whl
| Download URL | readmegen_cli-0.1.4-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f66ee1943f07ba9541ba4957bd9edf8c4d5eb6e5bc56025f33cf999171b00b9f
|
|
BLAKE2b-256 checksum How to use checksums |
76ee8ce6487100a0073b681328525d9564416a4611057259f61d8e494c775a23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.5
|
Security for readmegen-cli 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.