resin
| Crates.io | resin |
| lib.rs | resin |
| version | 1.6.3 |
| created_at | 2021-05-09 01:51:17.378841+00 |
| updated_at | 2025-05-01 03:02:15.881342+00 |
| description | Fast CLI for conventional commits |
| homepage | https://github.com/gleich/resin/ |
| repository | https://github.com/gleich/resin/ |
| max_upload_size | |
| id | 395051 |
| size | 1,230,478 |
Matt Gleich (gleich)
documentation
README
resin 
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:
This demo will create the following commit message:
feat[config]: add crates.io fields
Features
Flags
resin has three flags:
- --help (-h) -> display a help message to the terminal
- --all (-a) -> run
git add .before committing the changes - --push (-p) -> run
git pushafter 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