diff --git a/README.md b/README.md index 280ef47..2f9efe4 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ # DevGen +
-> **Your AI Powerhouse for Git & Project Management.** -> Stop wasting time on repetitive tasks. Automate your commits, changelogs, and project essentials with a single CLI. -> + +**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 -PyPI -Python -License -Build Status -Pre-Commit Status +> PyPI +> Python +> License +> Build Status +> Pre-Commit Status +
## 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. ## 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. @@ -23,6 +28,7 @@ DevGen is an innovative CLI tool designed to streamline your development workflo - **Customizable**: Define your own commit message structure using Jinja2 templates. ## 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. @@ -36,6 +42,7 @@ DevGen is an innovative CLI tool designed to streamline your development workflo - **Google GenAI 1.66.0**: For AI model integration. ## Installation + Get started with DevGen in seconds using one of the following methods: ```bash @@ -53,7 +60,9 @@ devgen --install-completion ``` ## Usage + ### Initialize & Configure + Tell DevGen which AI provider to use. ```bash @@ -61,6 +70,7 @@ devgen setup config ``` ### Stage & Commit + Stage your files and let AI write the message. ```bash @@ -69,6 +79,7 @@ devgen commit run ``` ### Preview Commit Message + Preview what DevGen will generate without committing. ```bash @@ -76,6 +87,7 @@ devgen commit run --dry-run ``` ### Commit and Push + Commit and push in one go. ```bash @@ -83,6 +95,7 @@ devgen commit run --push ``` ### Review and Edit + Review and edit AI messages before committing. ```bash @@ -90,6 +103,7 @@ devgen commit run --check ``` ### Undo Last Commit + Undo the last AI commit and keep changes staged. ```bash @@ -97,19 +111,25 @@ devgen commit undo ``` ## API Documentation + For more detailed API information and available commands, please refer to the [DevGen CLI Documentation](https://devgen.readthedocs.io/). ## Contributing + We welcome contributions! Found a bug? Want a new feature? Open an issue or submit a PR. ## Troubleshooting + If you encounter any issues, please refer to our [Troubleshooting Guide](https://devgen.readthedocs.io/en/latest/troubleshooting.html). ## License + Proudly open source under the [GPL-3.0-or-later](LICENSE) License. ## 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. @@ -117,4 +137,4 @@ DevGen wouldn't be possible without these amazing open-source projects and AI pr
Made with ❤️ by Sankalp -
\ No newline at end of file +