Convinci

A fast and interactive terminal helper that guides you step-by-step to create clean and standardized Conventional Commits, making your Git history perfectly readable.

🚀 Features

Intuitive TUI Interface

Navigate a fast and user-friendly Text-based User Interface (TUI) to easily compose your commit messages.

Step-by-Step Guidance

Convinci walks you through each part of the commit message, ensuring adherence to the Conventional Commits specification.

Full Type Support

Supports all standard conventional commit types: feat, fix, chore, docs, and many more, with optional emojis.

Breaking Change Handling

Clearly indicate and describe breaking changes, automatically including them in your commit footer.

📦 Installation

Choose your platform and get Convinci running in seconds!

Linux / macOS

curl -sSL https://convinci.pages.dev/scripts/install.sh | bash
Or with wget:
 wget -qO- https://convinci.pages.dev/scripts/install.sh | bash

Note: You might need to grant execute permissions or use sudo if installing to a system directory like /usr/local/bin

Want to inspect the installer script? View on GitHub

Windows (PowerShell)

powershell -NoProfile -ExecutionPolicy Bypass -Command "iex (Invoke-RestMethod -Uri 'https://convinci.pages.dev/scripts/install.ps1')"

Note: Run PowerShell as an administrator for successful installation to the user's bin directory and PATH modification.

Want to inspect the installer script? View on GitHub

Alternative (with Rust installed)

cargo install convinci

💡 Usage

Navigate to your Git repository and simply run:

convinci

Convinci will guide you through the process. Here are some common options:

Enable Emojis in Commit Message

convinci --emoji

Run in Demo Mode (no commit)

convinci --demo

See Full Help Message

convinci --help