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

Keybindings

❌ Uninstallation

Linux/macOS

sudo rm $(which convinci)

Windows

1. Delete convinci.exe from your bin directory (%USERPROFILE%\bin)
2. 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 master branch

Reporting Issues

Found a bug? Have a feature request? Please open an issue.

📜 License

Convinci is open-source software licensed under the MIT License.