https://github.com/segersniels/convit
In an effort to make it easier to write conventional commit messages, convit is a command-line tool that allows you to write conventional commit messages.
https://github.com/segersniels/convit
cli commit commit-message conventional-commits prompt tool
Last synced: about 22 hours ago
JSON representation
In an effort to make it easier to write conventional commit messages, convit is a command-line tool that allows you to write conventional commit messages.
- Host: GitHub
- URL: https://github.com/segersniels/convit
- Owner: segersniels
- Created: 2024-07-17T14:07:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-25T14:49:11.000Z (over 1 year ago)
- Last Synced: 2025-08-03T06:25:48.453Z (6 months ago)
- Topics: cli, commit, commit-message, conventional-commits, prompt, tool
- Language: Go
- Homepage:
- Size: 296 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# convit
> [!NOTE]
> This tool has been deprecated in favor of [`cmt`](https://github.com/segersniels/cmt) and won't be maintained anymore.
> For future updates check out [`cmt`](https://github.com/segersniels/cmt).
In an effort to make it easier to write conventional commit messages, `convit` is a command-line tool that allows you to write conventional commit messages.
## Install
```bash
# Install in the current directory
curl -sSL https://raw.githubusercontent.com/segersniels/convit/master/scripts/install.sh | bash
# Install in /usr/local/bin
curl -sSL https://raw.githubusercontent.com/segersniels/convit/master/scripts/install.sh | sudo bash -s /usr/local/bin
```
### Manual
1. Download the latest binary from the [releases](https://github.com/segersniels/convit/releases/latest) page for your system
2. Rename the binary to `convit`
3. Copy the binary to a location in your `$PATH`
## Usage
```
NAME:
convit - Write conventional commit messages
USAGE:
convit [global options] command [command options]
VERSION:
x.x.x
COMMANDS:
commit Write a commit message
generate Write a commit message with the help of OpenAI
config Configure the app
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```
### Generate
Experimental feature that uses AI to assist with writing a conventional commit message. It looks at the currently staged changes that you want to commit and a user specified commit message to determine the type & optional scope of the commit.
```bash
convit generate
```
> This feature is _bring-your-own-key_ and requires the `OPENAI_API_KEY` or `ANTHROPIC_API_KEY` environment variable to be set depending on the configured model.