carloscuesta / gitmoji-cli

gitmoji-cli > A gitmoji interactive client for using gitmojis on commit messages. About This project provides an easy solution for using **gitmoji** from your command line. Gitmoji-cli solves the hassle of searching through the gitmoji list. Includes a bunch of options you can play with! :tada: Install npm brew Usage Commit You can use the commit functionality in two ways, directly or via a commit-hook. If you want to integrate in your project I would recommend going for the **hook mode** as it support more use cases, it's more flexible and has a better integration with other tools, whereas the **client mode** is more quick and easy to use. Client Start the interactive commit client, to auto generate your commit based on your prompts. Options You can pass default values to the prompts using the following flags: • : For setting the commit title. • : For setting the commit message. • : For setting the commit scope. Those flags should be used like this: Hook Run the init option, add your changes and commit them, after that the prompts will begin and your commit message will be built. ⚠️ The hook **should not be used** with the command. Search Search using specific keywords to find the right gitmoji. List Pretty print all the available gitmojis. Update Update the gitmojis list, by default the first time you run gitmoji, the cli creates a cache to allow using this tool without internet connection. Config The cli has some built-in configuration options that you can tweak at your own preference: • **Automatic git add**: Enable or disable the automatic every time you use the commit command. • **Emoji format**: Switch between the emoji format. • **Message prompt**: Enable or disable the message prompt. • **Scope prompt**: Enable or disable the conventional commits scope prompt, or specify your own predefined scopes in a array. • **Gitmojis api URL**: Set a custom URL to use it as the library of gitmojis. You can configure these options via (in order of precedence): • A key in your file • A file. • A key in a package.json file in a parent directory (recursively) • A file in a parent directory (recursively) • Using the global cli configuration. If no user configuration is found, a set of default values will be used. Local configuration Run to setup some gitmoji-cli preferences.