Skip to main content

現在、GitHub AE は限定的リリースです。

GitHub CLI クイックスタート

GitHub CLI を使用して、コマンド ラインで GitHub を操作します。

GitHub CLI について

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

作業の開始

  1. macOS、Windows、または Linux に GitHub CLI をインストールします。

  2. コマンド ライン内で GitHub に対する認証を行います。 HOSTNAME を ご自分のエンタープライズ の名前に置き換えます。 たとえば、octo-inc.ghe.com です。

    gh auth login --hostname HOSTNAME
    
  3. コマンド ラインで GitHub の操作を開始します。 たとえば、gh issue status または gh issue list --assignee @me を使用して、作業する Issue を見つけます。 gh pr create を使用してプルリクエストを作成します。 gh pr checkoutgh pr diffgh pr review を使用してプルリクエストを確認します。

次の手順

  • テキスト エディターを開くコマンドで使用されるテキスト エディターを GitHub CLI に指定します。 たとえば、gh config set editor "code -w" を入力して、優先するテキスト エディターに 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 CLI リファレンス」をご覧ください。