sankalp
7c15e2183b
The `README.md` has undergone a significant rewrite and restructuring to enhance readability, streamline the onboarding process, and better communicate the value proposition of DevGen. This includes a new introduction, a consolidated "Why DevGen?" section, simplified quick start guides, and a dedicated feature deep dive.
* **Enhancements & Refinements**
* **Improved Introduction**: Added a concise tagline and refined the introductory paragraph, positioning DevGen as an AI co-pilot for Git and project management.
* **Streamlined Feature Presentation**: Replaced the previous feature list with a "Why DevGen?" section, highlighting key benefits such as AI Brain (multi-provider support), battle-tested compliance (Conventional Commits, Semantic Versioning), lightning-fast performance, and zero-friction setup.
* **Simplified Quick Start**: Refined the initial setup and commit generation steps for a quicker onboarding experience.
* **Enhanced Feature Deep Dive**: Introduced a dedicated section to provide detailed usage examples for AI-powered commits, changelogs, release notes, gitignore, and license generation.
* **Improved Installation Instructions**: Emphasized `pipx` and `uv` as recommended installation methods for isolated and fast CLI management.
* **Concise Configuration Table**: Replaced verbose configuration details with a clear markdown table for easier reference.
* **Updated PyPI Link**: Corrected the PyPI link to `devgen-cli`.
* **Minor Visual Updates**: Refined badge presentation and added a centered footer with author attribution.
* **Refactoring**
* **Major Content Restructuring**: Completely reordered and rewrote large sections, removing redundant information and consolidating related content to improve overall flow and conciseness.
* **Removed Command Reference**: Integrated command examples directly into relevant usage sections, eliminating a separate, lengthy command reference.
* **Removed Redundant Sections**: Consolidated information previously found in "Use Cases" and "Requirements" into other sections, streamlining the document.
DevGen
Your AI Co-Pilot for Git & Project Management. Stop wasting time on repetitive tasks. Automate your commits, changelogs, and project essentials with a single CLI.
PyPI didn't allow the original name, so you'll find it as devgen-cli on PyPI
DevGen isn't just another CLI tool—it's your development workflow on steroids. By leveraging state-of-the-art AI models, DevGen turns tedious manual tasks into one-click magic. From semantic commit messages to comprehensive release notes, DevGen handles the boring stuff so you can focus on building.
⚡ Why DevGen?
- 🧠 AI Brain: Semantic commit messages powered by Gemini, OpenAI, Claude, HuggingFace, and OpenRouter. It reads your diffs and understands your code.
- 🚀 Battle Tested: Generates Conventional Commits and Semantic Versioning compliant changelogs that actually make sense.
- ⚡ Lightning Fast: Smart caching and async operations mean you never wait longer than necessary.
- Project Essentials: Quickly add
.gitignoreand license files to your existing projects. Access cached templates instantly, even without internet. - 🛠️ Zero Friction: Interactive setup gets you running in seconds.
📦 Installation
Get started in seconds.
# Recommended: Install via pipx for an isolated environment
pipx install devgen-cli
# Or use uv for blazing speed
uv tool install devgen-cli
# Standard pip install
pip install devgen-cli
🚀 Quick Start
1. Initialize & Configure Tell DevGen which AI provider to use.
devgen setup config
2. Stage & Commit Stage your files and let AI write the message.
git add .
devgen commit run
Boom. Done.
💡 Feature Deep Dive
🤖 AI-Powered Commits
Stop writing "fix bug" or "wip". DevGen analyzes your staged changes, groups them by component, and generates meaningful, semantic commit messages.
# Preview what DevGen will generate
devgen commit run --dry-run
# Commit and push in one go
devgen commit run --push
📝 Changelogs & Release Notes
Turn your git history into beautiful, readable documentation.
# Generate a changelog from the last tag
devgen changelog generate
# Create release notes for v2.0.0
devgen release notes --version 2.0.0
🛡️ Essential Files
Don't waste time searching for templates. Generate the essential files for your project instantly.
# Interactive search for gitignore templates
devgen gitignore generate
# Generate a license interactively
devgen license generate
⚙️ Configuration
Your settings live in ~/.devgen.yaml. You can tweak your AI provider, model, and preferences there.
| Option | Description |
|---|---|
provider |
gemini, openai, anthropic, huggingface, openrouter |
model |
Specific model name (e.g., gemini-2.5-flash, gpt-4o) |
emoji |
Enable/disable gitmojis in commits (true/false) |
🤝 Contributing
We love contributions! Found a bug? Want a new feature? Open an issue or submit a PR.
📝 License
Proudly open source under the GPL-3.0-or-later License.