自作CLIツールをHomebrewで公開しました

追記：この記事で紹介しているgit-coは、gibraへと名前を変更しました。GitHubリポジトリはこちら (opens in a new tab)です。

昔作成したCLIツールを、アップデートのついでにHomebrewでインストールできるようにしました。この記事では、その手順を紹介します。

作成したツールについては、最後に紹介します。

Homebrewでインストールできるようにする手順

GitHubのリリース機能を使ったバイナリの公開

こちら (opens in a new tab)のサイトを参考にして、GitHubのリリース機能でバイナリを公開することにしました。

まず、以下の手順を実行して、バイナリを作成しました。

cd path/to/git-co
cargo build --release
cd target/release
tar -czf git-co-0.3.0-x86_64-apple-darwin.tar.gz git-co
shasum -a 256 git-co-0.3.0-x86_64-apple-darwin.tar.gz

SHA256の値は、Formulaファイルを作成するときに使います。

その後、GitHub上でリリースを作成して、そのリリースにアセットとしてバイナリをアップロードしました。

HomebrewのFormulaの作成

こちら (opens in a new tab)のサイトを参考にして、HomebrewのFormulaファイルを一元管理するリポジトリを作成することにしました。

僕は、homebrew-tapという名前のリポジトリを作成しました。

https://github.com/neoki07/homebrew-tap (opens in a new tab)

その後、git-co用のFormulaファイルを作成しました。

class GitCo < Formula
  desc "A CLI tool for branch switching by providing a selection-based checkout process"
  homepage "https://github.com/neoki07/git-co"
  url "https://github.com/neoki07/git-co/releases/download/v0.3.0/git-co-0.3.0-x86_64-apple-darwin.tar.gz"
  sha256 "972bf109ca9a0c02ecad10e383409258c6a1380c992d98f521c5234f09784a94"
  license "MIT"
  version "0.3.0"
 
  def install
    bin.install "git-co"
  end
 
  test do
    system "#{bin}/git-co --version"
  end
end

urlの値には、先ほどアップロードしたバイナリのURLを指定し、sha256の値には、先ほどビルド時にshasumコマンドで算出したSHA256の値を指定します。

このFormulaファイルをプッシュことで、Homebrewでインストールできるようになります。インストールは、以下のコマンドで実行できます。

brew install neoki07/tap/git-co

作成したCLIツールの紹介

最後に、簡単にCLIツールの紹介をしておきます。git-coという名前のツールで、git checkoutの代わりに使えるCLIツールです。git-coコマンドを実行すると、存在するブランチの一覧が表示され、その中から選択したブランチに切り替えることができます。

よろしければ、使ってみてください。

https://github.com/neoki07/git-co (opens in a new tab)