Repolode
carloscuesta

carloscuesta/gitmoji-cli

用于在 git 提交信息中快速添加 gitmoji 表情前缀的交互式命令行工具。

Star
4,829
Fork
212
未关闭 Issue
18
最近提交
5天前

这是什么?

gitmoji-cli 是 gitmoji 规范的命令行客户端。gitmoji 用表情符号标注提交信息,表示本次改动的类型。使用它之后,无需手动翻找 gitmoji 列表,可以直接在终端中浏览、搜索并选择表情,工具会根据提示的回答生成完整的提交信息。

工具提供两种提交方式:客户端模式(`gitmoji -c`)直接运行提示流程并提交;Hook 模式(`gitmoji -i`)挂接到 `git commit`,每次提交时自动触发提示。此外还支持列出全部 gitmoji、按关键词搜索,并可将表情列表与上游仓库同步。首次运行后会生成本地缓存,断网时也能使用。

配置可以写在 package.json 的 `gitmoji` 字段、`.gitmojirc.json` 文件中,也可以使用全局设置。可配置项包括自动执行 `git add`、表情格式(代码或表情符号)、是否显示消息与 scope 提示(可预设 scope 列表),以及自定义 gitmoji 接口地址。可通过 npm 或 Homebrew 安装。

核心功能

  • 01交互式选择 gitmoji,并通过提示生成提交信息。
  • 02支持客户端模式和 git commit Hook 模式。
  • 03在终端中列出并搜索全部 gitmoji。
  • 04本地缓存支持离线使用,也可按需同步表情列表。
  • 05可通过 package.json、.gitmojirc.json 或全局设置进行配置。

适用场景

  • 团队遵循 gitmoji 规范时,统一提交信息的风格。
  • 写提交信息时免去手动查找表情代码的麻烦。
  • 在项目中安装提交 Hook,统一约束提交格式。

快速上手

  1. 1

    使用 npm 全局安装 gitmoji-cli

    npm i -g gitmoji-cli
  2. 2

    启动交互式提交客户端

    gitmoji -c

使用前须知

  • 使用表情符号前缀,因此只适合遵循 gitmoji 约定的团队。

收录于专题

标签

#git#commit#cli#emoji#conventional-commits#developer-workflow#gitmoji#gitmoji-cli

常见问题

gitmoji-cli 是什么?
用于在 git 提交信息中快速添加 gitmoji 表情前缀的交互式命令行工具。 gitmoji-cli 是 gitmoji 规范的命令行客户端。gitmoji 用表情符号标注提交信息,表示本次改动的类型。使用它之后,无需手动翻找 gitmoji 列表,可以直接在终端中浏览、搜索并选择表情,工具会根据提示的回答生成完整的提交信息。
gitmoji-cli 可以免费使用吗?用的什么许可证?
gitmoji-cli 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
gitmoji-cli 还在维护吗?
活跃维护中。gitmoji-cli 最近一次提交是在 2026年11月2日。
gitmoji-cli 适合用来做什么?
团队遵循 gitmoji 规范时,统一提交信息的风格。 写提交信息时免去手动查找表情代码的麻烦。 在项目中安装提交 Hook,统一约束提交格式。
gitmoji-cli 怎么安装和运行?
使用 npm 全局安装 gitmoji-cli: npm i -g gitmoji-cli 启动交互式提交客户端: gitmoji -c
在哪里获取 gitmoji-cli?
源代码和安装说明在 GitHub 上:https://github.com/carloscuesta/gitmoji-cli

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目