mji

Table of content

• Installation
• Usage
• License
• Contributing
• TODO

Installation

From source

cargo build # to build or
cargo install  # to install 

From cargo binary

cargo install mji   

From AUR

yay -S mji 

Usage

Example usage:

mji --help # display all options 

mji # start interactive prompt 

mji --commit # start prompt mode and run commit command (defaults to git commit -e -am <mji output>)

mji ":sparkles: message 1" ":sparkles: message 2" # run mji in non-interactive mode 

The default commands for the header and commits can be change using the enviornment variables MJI_HEADER_COMMAND and MJI_COMMIT_COMMAND.

Custom emojis

The program will look for a configuration file called mji.toml in the system's default configuration location (e.g. $HOME/.config on Linux). The config location can also be changed using a command line parameter. The file should have the following structure (one line per emoji):

crab = {name = "crab", value = "🦀", desc = "Made with Rust"} 

License

This program is distributed under the terms of the MIT License.

Contributing

All contributions are welcome. Both pull requests and issue reports are always appreciated. Please make sure that all existing tests pass before submitting a pull request.