Repolode
carloscuesta

carloscuesta/gitmoji-cli

gitmojiの絵文字を先頭に付けたGitコミットメッセージを作成できる、対話型のコマンドラインツールです。

スター
4,829
フォーク
212
未解決の Issue
18
最終コミット
5 日前

これは何?

gitmoji-cliは、変更の種類を示す絵文字をコミットメッセージに付けるgitmoji規約に対応したコマンドラインツールです。gitmojiの一覧を手作業で調べる代わりに、ターミナル上で一覧を見たり、検索したりして絵文字を選べます。プロンプトへの回答をもとに、コミットメッセージを組み立てます。

コミット方法は2種類あります。クライアントモード(`gitmoji -c`)ではプロンプトに答えると、そのままコミットできます。フックモード(`gitmoji -i`)では`git commit`に連携し、コミットのたびにプロンプトを表示します。ほかにも、gitmojiの一覧表示やキーワード検索、上流リポジトリとの絵文字一覧の同期が可能です。ローカルキャッシュにより、オフラインでも一覧を利用できます。

設定は、package.jsonの`gitmoji`キー、`.gitmojirc.json`ファイル、またはグローバル設定から行えます。`git add`の自動実行、絵文字の形式(コードまたは絵文字)、任意のメッセージやスコープを尋ねるプロンプトと定義済みスコープ、独自のgitmojis API URLなどを設定できます。npmまたはHomebrewでインストールできます。

主な機能

  • 01対話形式でgitmojiを選び、プロンプトへの回答からコミットメッセージを作成できます。
  • 02クライアントモード、またはgit commitフックとして実行できます。
  • 03ターミナルから利用可能なgitmojiの一覧表示や検索ができます。
  • 04ローカルキャッシュによりオフラインで利用でき、必要に応じて一覧を同期できます。
  • 05package.json、.gitmojirc.json、またはグローバル設定で構成できます。

ユースケース

  • gitmoji規約に従うチームで、コミット履歴の一貫性を保つ。
  • コミットメッセージを書く際に、絵文字コードを手作業で調べる手間を省く。
  • コミットフックを導入して、プロジェクトのコミット形式を統一する。

クイックスタート

  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 とは?
gitmojiの絵文字を先頭に付けたGitコミットメッセージを作成できる、対話型のコマンドラインツールです。 gitmoji-cliは、変更の種類を示す絵文字をコミットメッセージに付けるgitmoji規約に対応したコマンドラインツールです。gitmojiの一覧を手作業で調べる代わりに、ターミナル上で一覧を見たり、検索したりして絵文字を選べます。プロンプトへの回答をもとに、コミットメッセージを組み立てます。
gitmoji-cli は無料で使えますか?ライセンスは?
gitmoji-cli は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
gitmoji-cli は今もメンテナンスされていますか?
活発にメンテナンス中。gitmoji-cli の最終コミットは 2026年11月2日 です。
gitmoji-cli は何に使えますか?
gitmoji規約に従うチームで、コミット履歴の一貫性を保つ。 コミットメッセージを書く際に、絵文字コードを手作業で調べる手間を省く。 コミットフックを導入して、プロジェクトのコミット形式を統一する。
gitmoji-cli のインストール方法は?
npmでgitmoji-cliをグローバルインストールする: npm i -g gitmoji-cli 対話型のコミットクライアントを起動する: gitmoji -c
gitmoji-cli はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/carloscuesta/gitmoji-cli

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト