🦊 koji
An interactive CLI for creating [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/),
built on [cocogitto](https://github.com/oknozor/cocogitto) and inspired by
[cz-cli](https://github.com/commitizen/cz-cli).
[](https://github.com/its-danny/koji/releases)
[](https://github.com/its-danny/koji/actions)
[](https://codecov.io/gh/its-danny/koji)
[](https://deps.rs/repo/github/its-danny/koji)
[](https://conventionalcommits.org)
[](LICENSE)
[](https://github.com/its-danny/koji/raw/main/meta/demo.gif)
Features
- Create conventional commits with ease
- Use alongside cocogitto
for automatic versioning, changelog generation, and more
- Use emoji 👋 (or, shortcodes)
- Autocomplete for commit scope
- Run as a git hook
- Custom commit types
Installation
webi
bash
curl -sS https://webinstall.dev/koji | bash
cargo
bash
cargo install --locked koji
Be sure to have git installed first.
Usage
The basic way to use koji is as a replacement for git commit,
enforcing the conventional commit
standard by writing your commit through an interactive prompt.
```bash
Do some work
cd dev/nasa
git add stars
Commit your work
koji
```
See koji --help for more options.
Using as a git hook
An alternative way to use koji is as a git hook,
running it any time you run git commit.
Manually
Update .git/hooks/prepare-commit-msg with the following code:
```bash
!/bin/bash
koji --hook
```
bash
npx husky add .husky/prepare-commit-msg "koji --test"
Add this to your .rusty-hook.toml:
toml
prepare-commit-msg = "koji --hook"
Similar should work for any hook runner, just make sure you're using
it with the prepare-commit-msg hook.
When using it as a hook, any message passed to git commit -m will be used
for the commit summary. Writing your commit as a conventional commit,
e.g. git commit -m "feat(space): delete some stars", will bypass
koji altogether.
Configuration
Config files are prioritized in the following order:
- Passed in via
--config
.koji.toml in the working directory~/.config/koji/config.toml- The default config
Options
emoji
- Type:
bool
- Optional:
true
- Description: Prepend the commit summary with relevant emoji based on commit type.
toml
emoji = true
autocomplete
- Type:
bool
- Optional:
true
- Description: Enables auto-complete for scope prompt via scanning commit history.
toml
autocomplete = true
commit_types
- Type:
Vec<CommitType>
- Optional:
true
- Description: A list of commit types to use instead of the default.
toml
[[commit_types]]
name = "feat"
emoji = "✨"
description = "A new feature"