GitHub CLIコマンドのアカウントをコマンドで切り替える方法

作成日: 2023/02/11, 更新日: 2023/12/31

GitHub CLIコマンドを利用する際、GitHubアカウントを切り替える場合には


       gh auth login

コマンドを毎回実行していました。
プロファイルのように気軽に認証情報を切り替える方法がないか探していたところ、良い方法が見つかりましたので記事にさせて頂きます。

GitHub マルチアカウントの切り替え（GitHub CLI コマンド）
（おまけ）その他切り替え方法（2023年12月31日追記）

GitHub マルチアカウントの切り替え（GitHub CLI コマンド）

① 初期設定

GH CLI multi-account switch にある GitHub のエイリアス機能を利用して切り替える方法がシンプルだったため、少しカスタマイズして実装してみました。
- 参考サイトではアクセスする GitHub アカウント毎に ~/.config/gh/hosts.yml.${プロファイル名} を ~/.config/gh/config.yml へ追記しなければなりませんでした。

以下の方法では、プロファイルの作成と切り替えをエイリアス化することで、初期設定時以外は ~/.config/gh/config.yml ファイルを直接変更しなくても良いやり方で実装しています。
- ~~ただし、この方法ではあくまでも GitHub CLI の認証が変わるのみで、Git の認証はなぜか切り替わりません。~~
- ~~Git 側では以下のコマンドでクレデンシャルヘルパーを設定すれば、GitHub CLI でアカウントを切り替えなくても問題ございません。~~
- (2023/02/21 追記) 以下の設定を入れても GitHub CLI の認証を変更しないとレポジトリへアクセスできませんでした。


          git config --global 'credential.https://github.com.helper' ''
          git config --global --add 'credential.https://github.com.helper' '!gh auth git-credential'

初期設定としては、 ~/.config/gh/config.yml ファイルを vi エディタなどで開き、 aliases キーに create-profile と switch-profile のエイリアスを追加しています。エイリアス名や処理は好みで書き換えても OK です。
- create-profile では、 gh auth status コマンドで現在の認証状態を確認し、プロファイルを作成するかどうかを対話形式で確認しています。処理としては、 ~/.config/gh/hosts.yml ファイルを ~/.config/gh/hosts.yml.${プロファイル名} へコピーしています。
- switch-profile では、 ~/.config/gh/hosts.yml.${プロファイル名} ファイルが存在するかどうかを確認し、存在する場合は ~/.config/gh/hosts.yml ファイルへコピーしています。


          git_protocol: https
          aliases:
              create-profile: '!gh auth status && read -p "Do you create this profile? (y/N): " yn; case "$yn" in [yY]*) cp ~/.config/gh/hosts.yml ~/.config/gh/hosts.yml.$1 && echo "[INFO] New hosts file created: ~/.config/gh/hosts.yml.$1";; esac'
              switch-profile: '!if [ -e ~/.config/gh/hosts.yml.$1 ]; then cp ~/.config/gh/hosts.yml.$1 ~/.config/gh/hosts.yml && gh auth status && echo "[INFO] Hosts file switched"; else echo "[ERROR] Hosts file not found: ~/.config/gh/hosts.yml.$1"; fi'

yq コマンドで変更する場合は以下のコマンドを実行ください。


          # プロファイル作成コマンド
          yq -o yaml  -i '.aliases += {"create-profile": "''''!gh auth status && read -p \"Do you create this profile? (y/N): \" yn; case \"$yn\" in [yY]*) cp ~/.config/gh/hosts.yml ~/.config/gh/hosts.yml.$1 && echo \"[INFO] New hosts file created: ~/.config/gh/hosts.yml.$1\";; esac''''"}' ~/.config/gh/config.yml

          # プロファイル切り替えコマンド
          yq -o yaml  -i '.aliases += {"switch-profile": "''''!if [ -e ~/.config/gh/hosts.yml.$1 ]; then cp ~/.config/gh/hosts.yml.$1 ~/.config/gh/hosts.yml && gh auth status && echo \"[INFO] Hosts file switched\"; else echo \"[ERROR] Hosts file not found: ~/.config/gh/hosts.yml.$1\"; fi''''"}' ~/.config/gh/config.yml

② アカウント設定ファイル作成

gh auth login コマンドで GitHub アカウントへログインした後、プロファイルを作成したい場合は以下のコマンドを実行します。


          gh create-profile ${プロファイル名}

以下は実行例です。誤って上書きしてプロファイルを作成しないよう、対話形式で作成有無を確認するようにしています。 y を入力して Enter を押下すればプロファイルとしてファイルが生成されます。


          github.com
            ✓ Logged in to github.com as xxxxxxxxxx (oauth_token)
            ✓ Git operations for github.com configured to use https protocol.
            ✓ Token: *******************

          Do you create this profile? (y/N): y
          [INFO] New hosts file created: ~/.config/gh/hosts.yml.xxxx

③ アカウント切り替え方法

GitHub アカウントの切り替えを行いたい場合には以下のコマンドを実行します。


          gh switch-profile ${プロファイル名}

以下は実行例です。エイリアスのコマンドは単純な処理にしているため、プロファイルのファイルが存在するかしないかのみ判断して処理を行なってます。


          # プロファイルが存在する場合
          github.com
            ✓ Logged in to github.com as xxxxxxxxxx (oauth_token)
            ✓ Git operations for github.com configured to use https protocol.
            ✓ Token: *******************c

          [INFO] Hosts file switched

          # プロファイルが存在しない場合
          [ERROR] Hosts file not found: ~/.config/gh/hosts.yml.test

（おまけ）その他切り替え方法（2023年12月31日追記）

僕は 1Password ではなく Bitwarden を利用しているため試していませんが、1Password でも GitHub アカウントの切り替えが可能なようです。
- 参考: Use 1Password to authenticate the GitHub CLI with biometrics | 1Password Developer