1 个稳定版本

1.0.0 2020年2月2日

#71 in #commit-message

MITLGPL-3.0

21KB
411

gitmoji badge

gitmoji-cli

一个用于在提交信息中使用 gitmoji 的交互式客户端。

关于

该项目提供了一种简单的方法,让您可以从命令行使用 gitmoji。Gitmoji-cli 解决了在 gitmoji 列表中搜索的麻烦。包含许多您可以选择的选项!🎉 它是无耻地复制了 原始版本,但用 Rust 编写。

安装

$ cargo install gitmoji-cli

用法

$ gitmoji --help
A gitmoji interactive client for using gitmojis on commit messages.

USAGE:
    gitmoji [FLAGS] [OPTIONS]

FLAGS:
    -c, --commit     Interactively commit using the prompts
    -g, --config     Setup gitmoji-cli preferences
    -h, --help       Prints help information
    -i, --init       Initiliaze gitmoji as a commit hook
    -l, --list       List all the available gitmojis
    -r, --remove     Remove a previously initialized commit hook
    -u, --update     Sync emoji list with the repo
    -V, --version    Prints version information

OPTIONS:
    -s, --search <query>    Search gitmojis

提交

您可以使用两种方式使用提交功能,直接或通过提交钩子。

客户端

启动交互式提交客户端,根据提示自动生成您的提交。

$ gitmoji -c

钩子

运行 init 选项,添加您的更改并提交,然后提示将开始,并构建您的提交信息。

$ gitmoji -i
$ git add .
$ git commit

⚠️ 钩子 不应与 gitmoji -c 命令一起使用。

使用特定关键词搜索合适的 gitmoji。

$ gitmoji -s bug

列表

美观打印所有可用的 gitmoji。

$ gitmoji -l

更新

更新 gitmoji 列表,默认情况下,第一次运行 gitmoji 时,cli 创建缓存,以便在不连接互联网的情况下使用此工具。

$ gitmoji -u

配置

运行 gitmoji -g 来设置一些 gitmoji-cli 首选设置,例如自动 git add . 功能。

依赖项

~9–21MB
~346K SLoC