Launched
ターミナルにコントリビューショングラフを生成させる「gitviz」っていうツールについてのアイコン

ターミナルにコントリビューショングラフを生成させる「gitviz」っていうツールについて

ローカルのGitリポジトリのコントリビューションをGitHub風にターミナルにで可視化するCLIツール

Visit Product
プロダクトの感想・意見はこのエリアに表示されます

はじめに

Goで「gitviz」という、ローカルのGitリポジトリを基にコントリビューショングラフを生成するCLIツールを作成したので、そのツールを手短にサクッと紹介します!

使用技術

  • Go
    • v1.24.2
  • go-git
    • コミットログの集計等に使用

gitvizで何ができるか

gitviz では以下のコマンドオプションを用意しています。

-add オプション

まず、コントリビューショングラフの表示に必要なローカルのGitリポジトリの登録をこちらで行います。

これを叩くと、自動でホームディレクトリに.gitlocalstatsというドットファイルが作成されるようになっています。
そちらに.gitを含むディレクトリパスの登録を行ってくれます。
この-addオプションはプライベートリポジトリのパスの登録も行ってくれる仕様になっています。

コントリビューショングラフは、その生成された.gitlocalstatsを基にグラフの生成を行います。

-graph オプション

登録済みリポジトリを基にGitHub風のコントリビューショングラフを生成します。

-graphオプションでは実際にGitHubに登録しているメールアドレスを指定してあげることで、そのユーザーに基づいたグラフの生成をしてくれます。
以下がグラフのイメージになります。

画像の説明を入れてください
グラフのイメージ

現段階のカラーバリエーションでは青系統しか用意できていなくて、今後使用されるユーザーが自由に設定できるようにしていきたいと考えています。

インストール方法

インストール方法はHomebrewgo installのどちらかで可能です。
個人的にHomebrewを導入されている方はそちらでインストールする方が楽です。

Homebrewの場合

以下の手順でインストールを進めてください。

go install の場合

まとめ

今回は、gitvizという自己満CLIツールの紹介をさせていただきました。
興味のある方はぜひ試してみてください!
こういう機能欲しい!」などあれば、気軽にIssueを立ててもらえると嬉しいです。

Explore More
関連記事はありません。