https://nopipi.hatenablog.com/entry/2025/01/30/225826

はじめに

この記事は、GitHub CLIをセットアップして使ってみたメモです。

ghコマンドとは？

ghコマンドは、GitHubの管理を行うためのCLIコマンドです。ghコマンドを使うことで、リポジトリの作成/変更/削除やユーザー管理などGitHubの各種管理をコマンドラインにて実行することが可能になります。
詳しくは、下記の公式ドキュメントを参照ください。
docs.github.com

セットアップ

こちらの [GitHub CLI リポジトリ](https://github.com/cli/cli#installation) のドキュメントに説明がありますが、ここではMacOSにセットアップした時のメモを記載します。

インストール

brewのセットアップ

ここでは、brewを利用してインストールしています。brewが入っていない場合は先にbrewをセットアップします。
brewのインストールは以下のコマンドで実行します。詳しくは[brewのページ](https://brew.sh/ja/)を参照してください。

brewのインストール

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

実行パスの設定のため、以下内容を~/.zshrcに追加

# For brew command
eval "$(/opt/homebrew/bin/brew shellenv)"

実行確認

gh --version

ghコマンドのインストール

brew install gh

GitHubへのログイン認証

github.comに認証してログインします。

下記コマンドでgithub.comへのブラウザを利用したweb認証を開始します。

gh auth login --git-protocol https --hostname github.com --web

下記メッセージが表示されるのでyで進めます

? Authenticate Git with your GitHub credentials? Yes

ghコマンドでEnterキーを押すとブラウザ画面が出てくる
githubユーザーを確認して進め、ワンタイムコード入力画面が出たらghコマンドで表示されているXXXX-XXXXのコードを入力し進める
Passkeys設定が求められるのでクリックして進める
ghコマンドが進み、ログイン情報が表示されれば成功

ghコマンドの使い方

ここではいくつかの利用例を提示します。
詳しくは、下記のマニュアルを参照してください。
cli.github.com

リポジトリ関連操作

# 自分が所有するリポジトリの表示
gh repo list

# 指定したOrganizationが所有するリポジトリの表示(XXXXがOrganization名)
gh repo XXXX

# リポジトリの作成
gh repo create <Organization名>/<リポジトリ名>

Secrets/Variables関連操作

# secretsの一覧表示
gh secret list --env ENVIRONMENT_NAME

# secretsの設定
gh secret set NAME --body VALUE --env ENVIRONMENT_NAME

# secretsの削除
gh secret delete NAME  --env ENVIRONMENT_NAME

# variableの一覧表示
gh variable list --env ENVIRONMENT_NAME

# variableの設定
gh variable set NAME --body VALUE --env ENVIRONMENT_NAME

# variableの削除
gh variable delete NAME  --env ENVIRONMENT_NAME