CLI での GitHub Copilot の使用

GitHub コマンド ライン インターフェイスである gh を使用して、GitHub Copilot in the CLI を操作できます。

この記事の内容

GitHub Copilot in the CLI の使用について

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

GitHub Copilot in the CLI は GitHub CLI の拡張機能であり、ターミナルでチャットのようなインターフェイスを提供し、コマンド ラインから実行するコマンドに関する質問をすることができます。 Copilot in the CLI に、gh copilot suggest でユース ケースに適合するコマンドの提案を求めたり、gh copilot explain で知りたいコマンドの説明を求めたりできます。

さらに、一般的なヘルプには gh copilot --help を、特定のサブコマンドのヘルプには gh copilot SUBCOMMAND --help を使用できます。

前提条件

GitHub Copilot in the CLI にアクセスするには、次のものが必要です。

  • GitHub Copilot へのサブスクリプション: アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「GitHub Copilot の課金について」を参照してください。
  • Copilot in the CLI へのアクセス: GitHub Copilot Business サブスクリプションを持つ組織 の一員である場合、組織 所有者は、Copilot in the CLI へのアクセス権を付与する必要があります。 詳しくは、「CLI での GitHub Copilot の設定」を参照してください。
  • GitHub CLI をインストールする: GitHub CLI がインストールされている必要があります。 GitHub CLI のインストール手順については、GitHub CLI リポジトリを参照してください。
  • Copilot in the CLI 拡張機能をインストールする: さらに、Copilot in the CLI 拡張機能がインストールされている必要があります。 詳細については、「Copilot in the CLI のインストール」を参照してください。

Copilot in the CLI にコマンドの説明を求める

次のコマンドを実行して、Copilot in the CLI にコマンドの説明を求めることができます。

Shell
gh copilot explain

または、説明を受けたいコマンドを直接プロンプトに追加することもできます。

Shell
gh copilot explain "sudo apt-get"

Copilot in the CLI は、コマンドが実行する内容をわかりやすく説明してくれます。 これにより、コマンドの目的と、それが特定の例でどのように機能するかを理解しやすくなります。 この説明には、コマンドが入力として受け取り、出力として生成する内容に関する情報が含まれており、実用的な例が示されているため、コマンドのドキュメントを参照する必要はありません。

Copilot in the CLI にコマンドの提案を求める

次のコマンドを実行して、Copilot in the CLI にコマンドの提案を求めることができます。

Shell
gh copilot suggest

これにより、必要なコマンドにたどり着くための対話型エクスペリエンスが開始されます。 Copilot in the CLI は、実施しようとしているタスクの実行に役立つコマンドを提案しようとします。 Copilot in the CLI がより適切な提案ができるように、探しているコマンドの種類 (ジェネリック、git、gh) を指定できます。

必要なコマンドが既にわかっている場合は、プロンプトに含めることもできます。 たとえば、Git をインストールしたい場合は、Copilot in the CLI にコマンドの提案を次のように求めることができます。

Shell
gh copilot suggest "Install git"

結果が期待したものと異なる場合は、返されたコマンドが期待どおりになるまで質問を修正し続けることができます。 これを行うには、[コマンドの修正] オプションを選択します。

タスクに最適なコマンドを生成したら、[クリップボードにコピー] オプションを選択して、クリップボードに簡単にコピーして必要な場所で実行するか、そのコマンドを実行できます。

コマンドの実行

Copilot in the CLI がコマンドを提案すると、[コマンドの実行] オプションを選択してコマンドを実行できます。 gh copilot suggest 実行後にこのオプションを選択して提案を求めた場合、Copilot in the CLI はコマンドをクリップボードにコピーし、対話型セッションを自動的に終了します。 その後、コマンドを貼り付けてご自身で実行できます。

Copilot in the CLI が代わりにコマンドを実行する場合は、gh copilot alias によって生成された ghcs エイリアスがこのサポートを提供します。 ghcs エイリアスの構成の詳細については、「Copilot in the CLI 向けのエイリアスの設定」を参照してください。

ghcs エイリアスを使用し、[コマンドの実行] を選択すると、コマンドを実行する前に Copilot in the CLI から確認を求められます。 確認プロンプトは No にデフォルトで設定されていますが、gh copilot config オプションを使用してユーザー設定を変更できます。 詳しくは、「CLI での GitHub Copilot の構成」を参照してください。

確認すると、コマンドが実行され、後で参照できるようにシェル履歴に保存されます。

Copilot in the CLI 向けのエイリアスの設定

gh copilot alias を使用すると、Copilot in the CLI のエイリアスを作成できます。 エイリアスは Copilot in the CLI を使用する必要はありませんが、必要なキーボード操作が少なく、推奨コマンドの実行に役立つため、便利です。

また、指定されたエイリアスを使用して gh copilot suggest および gh copilot explain をラップできます。 指定されたエイリアスは ghcs および ghce です。 ghcs および ghce を使用するには、いくつかのエイリアス構成をシェル構成ファイルに追加する必要があります。

次の例は、Bash、PowerShell、Zsh 構成ファイルにエイリアス構成を追加する方法を示しています。

Bash

次のコマンドを実行して、Bash 構成ファイルにエイリアスを追加します。

Shell
echo 'eval "$(gh copilot alias -- bash)"' >> ~/.bashrc

PowerShell

次のコマンドを実行して、PowerShell プロファイルにエイリアスを追加します。

Shell
$GH_COPILOT_PROFILE = Join-Path -Path $(Split-Path -Path $PROFILE -Parent) -ChildPath "gh-copilot.ps1"
gh copilot alias -- pwsh | Out-File ( New-Item -Path $GH_COPILOT_PROFILE -Force )
echo ". `"$GH_COPILOT_PROFILE`"" >> $PROFILE

Zsh

次のコマンドを実行して、Zsh 構成ファイルにエイリアスを追加します。

Shell
echo 'eval "$(gh copilot alias -- zsh)"' >> ~/.zshrc

エイリアスを設定したら、以下を実行できます:

Shell
ghcs 'print "Hello world!"'

Copilot in the CLI についてのフィードバックを共有する

Copilot in the CLI で問題や制限が発生した場合は、Copilot in the CLI の [応答の評価] オプションを選択してフィードバックできます。