17 stable releases

new 1.6.3 May 1, 2025
1.6.0 Apr 12, 2022
1.5.0 Feb 19, 2022
1.4.0 Nov 21, 2021
0.1.0 May 9, 2021

#92 in Development tools

Download history 11/week @ 2025-01-13 1/week @ 2025-02-10 328/week @ 2025-04-28

328 downloads per month

MPL-2.0 license

1MB
373 lines

resin crates.io

lint build test

Superfast CLI for the conventional commits commit format

What is resin?

resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the conventional commit format. Here is a little demo:

demo

This demo will create the following commit message:

feat[config]: add crates.io fields

Features

Flags

resin has three flags:

  1. --help (-h) -> display a help message to the terminal
  2. --all (-a) -> run git add . before committing the changes
  3. --push (-p) -> run git push after committing the changes

Super simple and easy to use!

Configuration

Scopes

You can configure resin to have your custom scopes. Below is an example config:

scopes = ['docker', 'github actions']

Sign-off message

You can also have a sign-off message that is based off the contents of your ~/.gitconfig file:

sign = true

This will create a message that will automatically be added to the bottom of your commit message:

Signed-off-by: Matt Gleich <git@mattglei.ch>

Location

This file can be stored in ~/.config/resin/config.toml or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this for this project

Install

You can install resin using cargo:

cargo install resin

Dependencies

~4–13MB
~118K SLoC