sankalp/DevGen
1
0 Fork 0
Code Issues Pull Requests 8 Actions Packages Projects Releases 12 Wiki Activity

chore: auto-update README [skip ci]

Browse Source
This commit is contained in:
sankalp committed 2026-03-06 19:45:12 +05:45
1 parent b74fb8071a
commit 9e9c42ced7
1 file changed
+48 -110
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+48 -110
View File
@@ -1,42 +1,34 @@
# DevGen
<div align="center">
> **Your AI Powerhouse 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
<a href="https://pypi.org/project/devgen-cli"><img src="https://img.shields.io/pypi/v/devgen-cli?color=blue&label=PyPI&logo=pypi&logoColor=white" alt="PyPI"></a>
<img src="https://img.shields.io/badge/Python-3.10%2B-3776AB?logo=python&logoColor=white" alt="Python">
<a href="https://github.com/S4NKALP/DevGen/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPL--3.0--or--later-blue.svg" alt="License"></a>
</div>
---
## Overview
DevGen is an innovative CLI tool designed to streamline your development workflow by automating repetitive tasks such as commits, changelogs, and project essentials. Leveraging state-of-the-art AI models, DevGen transforms tedious manual tasks into one-click magic, enabling you to focus on building and improving your projects.
**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.
## Features
- **AI-Powered Commits**: Generate semantic, context-aware commit messages using AI models from Gemini, OpenAI, Anthropic, HuggingFace, and OpenRouter.
- **Battle-Tested**: Produces Conventional Commits and Semantic Versioning compliant changelogs that make sense.
- **Lightning Fast**: Utilizes smart caching and async operations for speedy performance.
- **Project Essentials**: Quickly add `.gitignore` and license files to your projects, with access to cached templates even offline.
- **Zero Friction**: Interactive setup gets you running in seconds.
- **Customizable**: Define your own commit message structure using Jinja2 templates.
## ⚡ Why DevGen?
## Tech Stack
- **Python 3.10+**: The primary programming language.
- **Typer & Rich**: For building the intuitive and responsive CLI interface.
- **Questionary**: For interactive prompts and selection menus.
- **Jinja2**: For the powerful template engine.
- **AI Models**: From Google Gemini, OpenAI, Anthropic, HuggingFace, and OpenRouter.
**🧠 AI Brain**
Semantic, context-aware commit messages powered by Gemini, OpenAI, Claude, HuggingFace, and OpenRouter. It reads your diffs, identifies project manifests, 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 `.gitignore` and 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.
## Installation
Get started with DevGen in seconds using one of the following methods:
```bash
# Recommended: Install via pipx for an isolated environment
@@ -52,16 +44,15 @@ pip install devgen-cli
devgen --install-completion
```
## 🚀 Quick Start
**1. Initialize & Configure**
## Usage
### Initialize & Configure
Tell DevGen which AI provider to use.
```bash
devgen setup config
```
**2. Stage & Commit**
### Stage & Commit
Stage your files and let AI write the message.
```bash
@@ -69,103 +60,50 @@ 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 Commit Message
Preview what DevGen will generate without committing.
```bash
# Preview what DevGen will generate
devgen commit run --dry-run
```
# Commit and push in one go
### Commit and Push
Commit and push in one go.
```bash
devgen commit run --push
```
# Review and edit AI messages before committing
### Review and Edit
Review and edit AI messages before committing.
```bash
devgen commit run --check
```
# Made a mistake? Undo the last AI commit and keep changes staged
### Undo Last Commit
Undo the last AI commit and keep changes staged.
```bash
devgen commit undo
```
### 🧠 Context Awareness
DevGen isn't just looking at the code changes; it's looking at the big picture. It automatically detects and analyzes:
- **Manifests**: `package.json`, `pyproject.toml`, `go.mod`, `Cargo.toml`, etc.
- **Lock Files**: `uv.lock`, `package-lock.json`, `poetry.lock`, etc.
## API Documentation
For more detailed API information and available commands, please refer to the [DevGen CLI Documentation](https://devgen.readthedocs.io/).
This allows the AI to understand *exactly* which library versions were updated, leading to hyper-accurate dependency commit messages.
### 📝 Changelogs & Release Notes
Turn your git history into beautiful, readable documentation.
```bash
# 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.
```bash
# 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`) |
| `custom_template` | Custom Jinja2 template for commit messages. |
### 🎨 Custom Templates
You can define your own commit message structure in `~/.devgen.yaml`. Use `devgen config info` to see available variables like `{{ group_name }}`, `{{ diff_text }}`, and `{{ context }}`.
Example:
```yaml
custom_template: |
{{ group_name }}: {{ diff_text }}
---
Manifests: {{ context }}
```
> [!TIP]
> Use `devgen config info` to see a full list of available variables and a template tip!
## 🤝 Contributing
We love contributions! Found a bug? Want a new feature? Open an issue or submit a PR.
## � Acknowledgments
## Contributing
We welcome contributions! Found a bug? Want a new feature? Open an issue or submit a PR.
## Acknowledgments
DevGen wouldn't be possible without these amazing open-source projects and AI providers:
- **Typer** & **Rich** for the CLI interface.
- **Questionary** for interactive prompts.
- **Jinja2** for the template engine.
- **Google Gemini**, **OpenAI**, **Anthropic**, **HuggingFace**, and **OpenRouter** for the AI models.
- **[Typer](https://typer.tiangolo.com/)** & **[Rich](https://rich.readthedocs.io/)** for building the beautiful, intuitive, and responsive CLI interface.
- **[Questionary](https://github.com/tmbo/questionary)** for creating interactive, user-friendly prompts and selection menus.
- **[Jinja2](https://jinja.palletsprojects.com/)** for the powerful template engine used to generate files and messages.
- **[Google Gemini](https://deepmind.google/technologies/gemini/)**, **[OpenAI](https://openai.com/)**, **[Anthropic](https://www.anthropic.com/)**, **[HuggingFace](https://huggingface.co/)**, and **[OpenRouter](https://openrouter.ai/)** for providing the advanced AI models that power the semantic generation features.
## �📝 License
## License
Proudly open source under the [GPL-3.0-or-later](LICENSE) License.
---
<div align="center">
Made with ❤️ by <a href="https://github.com/S4NKALP">Sankalp</a>
</div>
</div>