An elegant CLI tool that simplifies and streamlines your Git workflow with AI-powered commit messages, automated changelog generation, and intelligent version management.
- Generate conventional commit messages automatically using OpenAI
- Smart diff analysis that focuses on meaningful changes
- Support for custom commit types and emojis
- Breaking change detection
- Generate beautiful, structured changelogs from conventional commits
- Group commits by type with emoji categorization
- Support for multiple output formats
- Automatic git remote URL detection for commit links
- Semantic versioning with pre-release support
- Support for multiple project files (package.json, pyproject.toml, Cargo.toml, etc.)
- Automatic version bumping based on commit history
- Git tagging integration
- Global and workspace-specific settings
- YAML-based configuration files
- Interactive settings management
- Customizable commit types and emojis
pip install tgit
# AI-powered commit with automatic message generation
tgit commit
# Generate changelog for current version
tgit changelog
# Bump version and generate changelog
tgit version
# Interactive settings configuration
tgit settings
The easiest way to configure TGIT is through the interactive settings command:
# Interactive configuration - recommended!
tgit settings
This will guide you through setting up:
- OpenAI API key for AI-powered commits
- Preferred AI model (gpt-4, gpt-3.5-turbo, etc.)
- Commit emoji preferences
- Custom commit types
Alternatively, you can manually create a .tgit.yaml
file in your project root or ~/.tgit.yaml
for global settings:
apiKey: "your-openai-api-key"
model: "gpt-4"
commit:
emoji: true
types:
- type: "feat"
emoji: "✨"
- type: "fix"
emoji: "🐛"
# AI-powered commit
tgit commit
# Breaking change commit
tgit commit --breaking "remove deprecated api"
# Generate changelog for current version
tgit changelog
# Generate changelog from specific version
tgit changelog --from v1.0.0
# Generate changelog to specific version
tgit changelog --to v2.0.0
# Interactive version bump
tgit version
# Bump specific version type
tgit version --patch
tgit version --minor
tgit version --major
# Pre-release version
tgit version --prerelease alpha
# Interactive settings configuration
tgit settings
# Show current settings
tgit settings --show
# Clone the repository
git clone https://github.com/Jannchie/tgit.git
cd tgit
# Install with uv
uv pip install -e .
# Install development dependencies
uv pip install -e ".[dev]"
# Run all tests
./scripts/test.sh
# Run with coverage
./scripts/test.sh --coverage 90
# Run specific test types
./scripts/test.sh --unit
./scripts/test.sh --integration
# Run linting
ruff check .
# Run formatting
ruff format .
# Build package
uv build
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
If you encounter any problems or have suggestions, please open an issue on GitHub.