convinci
| Crates.io | convinci |
| lib.rs | convinci |
| version | 0.1.4 |
| created_at | 2025-06-22 23:36:34.474671+00 |
| updated_at | 2025-06-26 00:34:27.791138+00 |
| description | A fast terminal helper for creating conventional commits |
| homepage | |
| repository | https://github.com/alexandrefelipea/convinci |
| max_upload_size | |
| id | 1722032 |
| size | 76,640 |
Alexandre Felipe (alexandrefelipea)
documentation
README
Convinci 🚀 - Conventional Commits Helper
Convinci is a fast, intuitive terminal application that guides you through creating perfect Conventional Commits with an interactive TUI. Standardize your commit history and make it more readable in minutes!
✨ Features
- 🚀 Fast TUI interface
- 📝 Step-by-step guidance for perfect commits
- 🔄 Support for all standard commit types (
feat,fix,chore,docs, etc.) - ⚠️ Breaking change indicator and description
- 📦 Pre-built binaries for all major platforms
- ⌨️ Vim-style navigation (
jk) and keyboard shortcuts
📦 Installation
Linux/macOS
Install with curl:
curl -sSL https://raw.githubusercontent.com/alexandrefelipea/convinci/master/scripts/install.sh | bash
Or with wget:
wget -qO- https://raw.githubusercontent.com/alexandrefelipea/convinci/master/scripts/install.sh | bash
Windows (PowerShell)
Run as Administrator:
powershell -NoProfile -ExecutionPolicy Bypass -Command "iex (Invoke-RestMethod -Uri 'https://raw.githubusercontent.com/alexandrefelipea/convinci/master/scripts/install.ps1')"
Via Cargo (Rust developers)
cargo install convinci
git config --global alias.convinci '!convinci'
git config --global alias.cv '!convinci'
🔄 Updating
Update to the latest version using the same installation methods for Linux/macOS and Windows.
Updating Via Cargo:
cargo install convinci --force
💻 Usage
After installation, you can use Convinci directly or via Git aliases:
# Direct usage
convinci
# Via Git aliases (recommended)
git convinci
git cv
Command Options
| Option | Description | Example |
|---|---|---|
-d, --demo |
Demo mode (no actual commit) | convinci --demo |
-v, --version |
Show version information | git convinci --version |
-h, --help |
Show help message | git cv --help |
Keybindings
| Keys | Action |
|---|---|
Tab/Shift+Tab |
Navigate between fields |
Ctrl+Enter |
Confirm and generate commit |
Ctrl+C |
Exit without committing |
↑↓/jk |
Navigate lists and options |
0-9 |
Quick select from numbered list |
❌ Uninstallation
Linux/macOS
sudo rm $(which convinci)
Windows
- Delete
convinci.exefrom your bin directory (%USERPROFILE%\bin) - Remove the directory from your PATH if needed
🤝 Contributing
We welcome contributions! Here's how to get started:
Prerequisites
- Rust (latest stable)
- Git
Setup & Development
# 1. Fork and clone the repository
git clone https://github.com/your-username/convinci.git
cd convinci
# 2. Build the project
cargo build
# 3. Run in development mode
cargo run -- --demo # Test with demo mode
Contribution Guidelines
- Follow existing code style and patterns
- Update documentation when changing features
- Use descriptive commit messages (Convinci can help!)
- Open pull requests against the
masterbranch
Reporting Issues
Found a bug? Have a feature request? Please open an issue.
📜 License
Convinci is open-source software licensed under the MIT License.