Conventional Commits Generator

Description

Interactive CLI tool for creating standardized commit messages following the conventional commits format. Includes support for commit body, emojis, and advanced commit management features.

Installation

Using pipx (recommended)

pipx install conventional-commits-generator

Using pip

pip install conventional-commits-generator

Development installation

# Clone the GitHub repository
git clone https://github.com/EgydioBNeto/conventional-commits-generator.git

# Navigate into the project directory
cd conventional-commits-generator

# Grant execute permission to the virtual environment setup script
chmod +x scripts/setup_venv.sh

# Run the script to create and set up the virtual environment
./scripts/setup_venv.sh

# Activate the virtual environment
source .venv/bin/activate

Usage

Basic commands

# Create interactive commit
ccg

# Generate commit message without committing
ccg --commit

# Push only without creating commit
ccg --push

# Edit existing commit
ccg --edit

# Delete existing commit
ccg --delete

# Create and push tag
ccg --tag

# Reset local and pull from remote
ccg --reset

# Analyze commit messages for Conventional Commits compliance
ccg --analyze

# Stage specific files or directories
ccg --path src/ tests/

# Work in a different repository directory
ccg --path /path/to/repo

# Combine --path with other flags
ccg --path /path/to/repo --push

# Enable verbose logging for debugging
ccg --verbose
ccg -v

# Combine verbose with other flags
ccg --verbose --push
ccg -v --edit

# Show version
ccg --version

Interactive usage example

$ ccg

 ________      ________      ________
|\   ____\    |\   ____\    |\   ____\
\ \  \___|    \ \  \___|    \ \  \___|
 \ \  \        \ \  \        \ \  \  ___
  \ \  \____    \ \  \____    \ \  \|\  \
   \ \_______\   \ \_______\   \ \_______\
    \|_______|    \|_______|    \|_______|

 Conventional Commits Generator

Repository: my-project  Branch: main

┌──────────────────────┐
│ Commit Types         │
└──────────────────────┘

1. feat     - A new feature
2. fix      - A bug fix
3. chore    - Maintenance tasks
4. refactor - Code refactoring
5. style    - Style changes
6. docs     - Documentation
...

Choose the commit type: 1

┌──────────────────────┐
│ Scope                │
└──────────────────────┘
Enter the scope (optional): auth

┌──────────────────────┐
│ Breaking Change      │
└──────────────────────┘
Is this a BREAKING CHANGE? (y/N): n

┌──────────────────────┐
│ Emoji                │
└──────────────────────┘
Include emoji in commit message? (Y/n): n

┌──────────────────────┐
│ Commit Message       │
└──────────────────────┘
Enter the commit message: implement OAuth login

┌──────────────────────┐
│ Commit Body          │
└──────────────────────┘
Commit body (optional): Added Google OAuth 2.0 support
Integration with existing user system

┌──────────────────────┐
│ Review               │
└──────────────────────┘
Commit: feat(auth): implement OAuth login

Body:
Added Google OAuth 2.0 support
Integration with existing user system

Confirm this commit message? (Y/n): y
✓ Commit message confirmed!

┌──────────────────────┐
│ Push Changes         │
└──────────────────────┘
Do you want to push these changes? (Y/n): y
✓ Changes pushed successfully!

Analyze commits example

$ ccg --analyze

┌──────────────────────┐
│ Analyze Commits      │
└──────────────────────┘

How many commits to analyze? (Enter for all, or a number): 5

Analyzing last 5 commits...

┌──────────────────────┐
│ Analysis Results     │
└──────────────────────┘

1. ✓ [a3c6dbc] feat(ux): improvements in usability and responsiveness
2. ✓ [97c2e52] chore: removing unnecessary comments
3. ✗ [2812ed3] update bump version workflow
4. ✓ [fa6a6df] feat: adding improvements
5. ✓ [a5309a3] chore: add CODE_IMPROVEMENTS.md
┌──────────────────────┐
│ Summary              │
└──────────────────────┘

Total commits analyzed: 5
Valid commits: 4 (80%)
Invalid commits: 1 (20%)
How to fix invalid commits:
  • Use 'ccg --edit' to edit a specific commit message
  • You can select commits by number or hash prefix
  • Example: 'ccg --edit' then select the commit to fix
⚠ Tip: Run 'ccg --edit' now to fix invalid commits

Commit Types

Type	Description
feat	A new feature
fix	A bug fix
chore	Maintenance tasks
refactor	Code refactoring
style	Style/formatting changes
docs	Documentation changes
test	Adding or modifying tests
build	Build system changes
revert	Reverts a previous commit
ci	CI/CD changes
perf	Performance improvements

Requirements

• Python 3.9+
• Git

Contributing

See CONTRIBUTING.md for details on how to contribute.

Code of Conduct

Please read our Code of Conduct for details on our community standards.

Security

To report security vulnerabilities, see SECURITY.md.

License

This project is licensed under the MIT License.

Author

EgydioBNeto