GitHub CLI クイックスタート

GitHub CLI について

GitHub CLI は、コンピューターのコマンド ラインから GitHub を使用するためのオープン ソース ツールです。 コマンドラインから作業しているときは、GitHub CLI を使用して時間を節約し、コンテキストの切り替えを回避できます。

前提条件

1. macOS、Windows、または Linux に GitHub CLI をインストールします。 詳細については、GitHub CLI リポジトリ内でのインストールを参照してください。

2. GitHub に対して認証を行うには、ターミナルから次のコマンドを実行します。

   gh auth login
   

3. 認証を行う場所を選びます。

   • GitHub.com にある GitHub にアクセスする場合は、[GitHub.com] を選びます。
   • 別のドメインにある GitHub にアクセスする場合は、[Other] を選んでから、ホスト名を入力します (例: octocorp.ghe.com)。

4. 画面上の残りのプロンプトに従います。

   GitHub CLI は、Git 操作の優先プロトコルとして HTTPS を選択すると自動的に Git 資格情報を格納し、GitHub 資格情報で Git に対して認証するかどうかを尋ねるプロンプトに対して "はい" と答えます。 これは、別の資格情報マネージャーを設定したり、SSH を使用したりすることなく、git push、git pull などの Git コマンドを使用できるので便利です。

便利な コマンド

状態の表示

gh statusを入力すると、サブスクライブしているすべてのリポジトリの GitHub での現在の作業の詳細が表示されます。

リポジトリの表示

gh repo view OWNER/REPOを入力すると、リポジトリのREADME.mdの説明とリポジトリが表示されます。 gh repo view OWNER/REPO --webを入力して、既定のブラウザーでリポジトリを表示します。

GitHub 上にリモートがあるローカル Git リポジトリのディレクトリ内からサブコマンドrepoを実行する場合は、OWNER/REPOを省略できます。

リポジトリの複製

「gh repo clone OWNER/REPO」と入力します。 たとえば、ローカル コンピューターでこのコマンドを実行したディレクトリocto-org/octo-repoにリポジトリをgh repo clone octo-org/octo-repo複製します。

リポジトリを作成する

gh repo createを入力し、画面の指示に従います。 GitHub に新しい空のリポジトリを作成し、必要に応じてローカルに複製できます。 または、既存のローカル リポジトリを GitHub にプッシュし、必要に応じてローカル リポジトリのリモートとして設定することもできます。 ローカル ディレクトリを Git リポジトリとして設定する方法については、「ローカルでホストされているコードを GitHub に追加する」を参照してください。

問題点への取り組み

gh issue list --repo OWNER/REPOを入力すると、指定したリポジトリで現在オープンしている、最近作成された問題点を一覧表示します。 GitHub 上にリモートがあるローカル Git リポジトリのディレクトリ内からサブコマンドissueを実行する場合は、--repo OWNER/REPOを省略できます。 たとえば、このリポジトリであなたに割り当てられた課題を一覧表示したり、ユーザー "monalisa" が作成した課題をgh issue list --author monalisa一覧表示するには gh issue list --assignee "@me"を入力してください。

新しい問題を作成したり、「Issue の作成」を参照したり、問題を検索したりすることもできます。「Issue及びPull Requestのフィルタリングと検索」を参照してください。

pull request の取り扱い

gh pr list --repo OWNER/REPO を入力すると、指定したリポジトリで現在オープンしている、最近作成されたpull requestを一覧表示します。 GitHub 上にリモートがあるローカル Git リポジトリのディレクトリ内からサブコマンドprを実行する場合は、--repo OWNER/REPOを省略できます。 たとえば、このリポジトリで作成したオープンなプルリクエストをリストアップするためにgh pr list --author "@me"を入力します。

gh pr list --label LABEL-NAMEを入力すると、特定のラベルが付いたオープンなpull requestを一覧表示します。 確認を求められた pull request を一覧表示する場合にgh search prs --review-requested=@me --state=open を入力します。

pull request を作成するには、画面の指示に従ってgh pr create を入力します。 詳しくは、「pull request の作成」を参照してください。

コードスペースの取り扱い

新しいコードスペースを作成するには、画面の指示に従ってgh codespace create を入力します。

既存のコードスペースを表示するには、gh codespace listを入力します。 Web バージョンの VS Code でコードスペースを開くには、gh codespace code -w を入力してコードスペースを選択します。

これらのすべてのコマンドでは、cs次のコマンドcodespaceに置き換えることができます。

ヘルプの表示

gh を入力すると、最上位で使用できる GitHub CLI コマンドが表示されます。 たとえば、issue、pr、repo などです。

各コマンドと各補助サブコマンドに対して、--helpのフラグを追加して、その使用方法を確認できます。 たとえば、gh issue --help または gh issue create --help です。

GitHub CLIのカスタマイズ

構成設定を変更し、エイリアスまたは拡張機能を追加して、GitHub CLI を最適な方法で動作させることができます。

• gh config set SUBCOMMANDSを入力して GitHub CLIの設定を構成し、SUBCOMMANDSを調整したい設定で置き換えます。

  たとえば、GitHub CLI コマンドでテキストを編集する必要がある場合に使用するテキスト エディターを指定できます。たとえば、作成する新しい問題の本文テキストを追加する場合などです。 優先するテキスト エディターに Visual Studio Code を設定するには、gh config set editor "code -w" を入力します。 この例-w (または--wait) フラグを指定すると、コマンドは、ターミナルで次の手順に進む前に、Visual Studio Code でファイルが閉じられるのを待機します。

  詳細については、gh config setを参照してください。

• よく実行するコマンドのエイリアスを定義します。 たとえば、gh alias set prd "pr create --draft" を実行した場合、gh prd を実行すると、下書きのプルリクエストをすばやく開くことができるようになります。 詳細については、「gh alias」を参照してください。

• GitHub CLI 拡張機能を使用して、カスタム コマンドを作成または追加します。 詳細については、「GitHub CLI 拡張機能の使用」および「GitHub CLI 拡張機能の作成」を参照してください。

複数アカウントでの GitHub CLI の使用

お使いの GitHub Enterprise Server インスタンスなどの同じ GitHub プラットフォームに複数のアカウントがある場合は、それぞれを認証し、gh auth switch コマンドを使用して切り替えることができます。 GitHub CLI マニュアルの「gh auth switch」を参照してください。

GitHub.com の個人用アカウントや GHE.com のマネージド ユーザー アカウントなど、複数の GitHub プラットフォームで GitHub CLI を使用する必要がある場合は、「GitHub プラットフォーム間での GitHub CLI の使用」を参照してください。

参考資料

• GitHub CLI リファレンス
• GitHub CLI オンライン マニュアル