A smart Git workflow assistant that standardizes commit messages and pull request descriptions using AI-powered suggestions and conventional commit formats.
- Intelligent Commit Messages: Generate well-formatted commits following industry standards
- AI-Powered PR Creation: Automatically craft meaningful pull request titles and descriptions
- Flexible Message Formats:
- Conventional commit format support
- Long-form and concise message options
- Customizable prompts for different team needs
Ensure the following tools are installed:
- Git
- GitHub CLI (
gh) - Gum
- Mods (AI command-line tool)
- OpenAI API Key
- Install Required Tools
# macOS (using Homebrew)
brew install gh
brew install charmbracelet/tap/mods
brew install gum- Set Up OpenAI API Key
- Create an account at OpenAI
- Generate an API key
- Set the environment variable:
export OPENAI_API_KEY='your_openai_api_key'- Clone and Install Git-Relax
git clone https://github.com/yourusername/git-relax.git
cd git-relax
./install.sh- Add to PATH
echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
# Or for zsh users
echo 'export PATH=$PATH:~/.local/bin' >> ~/.zshrcgit-relax commitgit-relax prfix: Bug fixes and patchesfeat: New featuresbuild: Build system changeschore: Maintenance tasksci: CI configuration updatesdocs: Documentation improvementsstyle: Code style modificationsrefactor: Code restructuringperf: Performance enhancementstest: Test-related changes
Generated PRs follow a structured format:
- Problems addressed
- Solution approach
- Implementation details
- Testing steps
- Dependency changes
- Deployment notes
- Fork the repository
- Create a feature branch
- Commit using
git-relax commit - Push your changes
- Create PR using
git-relax pr
MIT License - see LICENSE file for details.
- Inspired by conventional commit standards
- Built for developer productivity
- Community-driven development