はじめに

この記事では、Github Copilotの機能の一覧をまとめたチートシートを紹介します。

Github Copilotとは

Microsoftによって開発されたAIベースのコーディングアシスタントです。
AIによるコードの自動補完やコードの提案機能を提供します。

  1. コード補完: コーディング中にAIが提案するコード補完を活用して、効率的にコーディングを進めます。
  2. ドキュメントやコメントの生成: コードに関するドキュメントやコメントをAIが自動生成してくれる機能を活用します。

IDEの拡張機能

CopilotはそれぞれのIDEに対応するGitHub Copilot拡張機能をインストールすることで、IDEで開いているファイルのコードの自動補完や、コードの提案を提供します。

対応するエディタとして以下のようなものがあります。

  • Azure Data Studio
  • JetBrains IDEs
  • Vim/Neovim
  • Visual Studio
  • Visual Studio Code

Github copilot公式ドキュメント: IDE拡張機能

GitHub Copilot Chat

GitHub Copilot Chatは、コーディング関連の質問をしたり、回答を受け取ったりできるチャットインターフェイスを提供します。

Copilot Chatは、Visual Studio Codeの場合は4種類のチャット欄から利用できます。

  • クイックチャット(画面上部に表示)
  • インラインチャット(現在のカーソル位置に表示)
  • チャットビュー(サイドパネルに表示)
  • チャットエディタ(エディタのタブに表示)

Copliot Chatで生成したテキストはチャット欄からコピーやインサートをすることができます。

Github Copilot公式ドキュメント

Participants

Visual StudioやVs Codeでは、「Participants」という機能が使えます。
GitHub Copilot Chatの「Participants」は、エディタ上で開いているファイル以外だけでなく、より幅広いコンテキストに対しての回答や操作を可能にする機能です。

Participantsはネット上では、Agentsなどとも呼ばれています。

従来のCopilotは主にエディタで開いているファイルや直接関連するコードブロックに対してのみ操作や提案を行っていましたが、Participantsを使用することで、エディタで開いているファイル以外にも質問が可能になります。

以下の3種類のParticipantsが用意されており、チャット欄の先頭に@から始まるコマンドを入力することで使用することができます。

  • @workspace : プロジェクト全体への質問、操作を行う
  • @vscode : VS Codeの操作方法などについて質問する
  • @terminal : ターミナルで何かをする方法について質問する

Visual Studioブログ

@workspace

@workspaceはCopilotへの質問の範囲をプロジェクト(ワークスペース)全体を対象する機能です。

ユースケースとしては、以下のようなものがあります。

  • ワークスペースについての質問
@workspace 現在のワークスペース構造について説明して
@workspace このアプリを実行するにはどうすればよい?
@workspace このアプリをデプロイするためのファイルはどこにある?
  • 問題の解決策を提案させる
@workspace Webサーバーから"413 コンテンツが大きすぎます" と応答されるのはなぜ
  • ワークスペースに新しい機能を追加する
@workspace ログをファイルに出力する機能を追加
@workspace パス "/hello" にするHelloWorldと応答する機能を追加
  • リファクタリング
@workspace envファイルを開発と本番で切り替えるようにしたい

@workspaceにはスラッシュから始まるサブコマンドのようなものがあり、ワークスペースに対して事前に組み込まれた操作を実行することができます。

スラッシュコマンド 説明
/explain 選択したコードの動作を説明する
/tests 選択したコードのユニットテストを生成する
/fix 選択したコードの問題を修正する提案をする
/new 新しいプロジェクトやファイルをスキャフォールド（雛形を作成）
/newNotebook 新しいJupyter Notebookを作成する
/clear Copilotのチャット履歴をクリアし、新しいチャット履歴を表示
@vscode

@vscodeはVS Codeについて質問することができます。

  • VS Codeの操作方法について質問
@vscode ショートカットキーの表示するには?
@vscode エディターのフォントサイズを変更するには？

@vscodeでは、以下のスラッシュコマンドを使用することができます。

スラッシュコマンド 説明
@vscode /api VS Codeの拡張開発について質問する 
@vscode /api `vscode.commands` APIでエラーが発生したので解決したい.
@terminal

@terminalはターミナル操作に関する質問をするために使用します。
@terminalを使用すると、ユーザーが使用しているターミナルに基づいて回答が行われる模様。
例えば、ターミナルがPowershellならgrepコマンドについて質問するとSelect-Stringについて回答が行われます。

以下にいくつかのユースケースを示します。

  • コマンドの使用方法について質問
@terminal grepを使ってファイル中の特定の文字列を検索するには?
@terminal gitでコミットを取り消すには?
  • タスクのコマンド化を依頼
@terminal ディレクトリを作成したい 
@terminal ビルドを自動化したい

GitHub Copilot in the CLI

GitHub Copilot in the CLIは、ターミナルにチャットのようなインターフェイスを提供し、コマンドラインに関する質問をすることができます。

CLI Copilot のインストールするには以下のコマンドを実行します。

# 認証を実施
gh auth login

# GitHub Copilot CLIをインストール
gh extension install github/gh-copilot

# CLI で Copilot を更新する
gh extension upgrade gh-copilot

CLI で Copilotの使い方 CLI で Copilot にコマンドの説明を依頼するには、次のコマンドを実行します。

# sudo apt-getの説明を表示
gh copilot explain "sudo apt-get"

# gitのインストール方法を提案
gh copilot suggest "Install git"

Github公式ドキュメント: Github Copilot CLI

Awesome GitHub Copilot Customizations

Awesome GitHub Copilot Customizationsはコミュニティから提供されているGitHub Copilotを強化するプロンプト集です。
チームのコーディング標準とプロジェクト要件に準拠した一貫したAI支援を受けることができます。

  • Custom Instructions
  • Reusable Prompts
  • Custom Chat Modes

Githubリポジトリ: Awesome-Copilot Microsoftブログ: Awesome-Copilot

Custom Instructions: .github/copilot-instructions.md

プロジェクト内の.github/copilot-instructions.mdのファイルのプロンプトの内容に基づいて、
GitHub Copilotの全体的なふるまいを設定することができます。(※所謂、システムインストラクション。)
ここで定義したプロンプトはすべてのチャットリクエストに渡されます。
Custom Instrunctionsではコーディング規約やテストケースなどコーディングのガイドラインを定義します。

以下の例はTailwind CSS のスタイリングパターンに沿った、Reactアプリケーションの作成を行うプロンプトです。

The page follows the development standards from your instructions:

- Uses React Server Components
- Implements proper TypeScript typing
- Follows Tailwind CSS styling patterns
- Maintains responsive design
- Uses semantic HTML
- Maintains consistent styling with the rest of the application

他には以下のようなものがあります。

Reusable Prompts: .gihub/prompts/*.md

.github/prompts/*.mdに保存されたプロンプトテンプレートを、スラッシュコマンドで呼び出し、再利用することができる機能です。
スラッシュコマンドで呼び出す際は、/ファイル名の形式で実行することで使用可能です。

以下の例はプルリクエストを自分に割り当てられたPRの一覧取得を行うプロンプトの例です。

---
mode: agent

tools: ['githubRepo', 'github', 'get_me', 'get_pull_request', 'get_pull_request_comments', 'get_pull_request_diff', 'get_pull_request_files', 'get_pull_request_reviews', 'get_pull_request_status', 'list_pull_requests', 'request_copilot_review'] 

description: "List my pull requests in the current repository" 
---

Search the current repo (using #githubRepo for the repo info) and list any pull requests you find (using #list_pull_requests) that are assigned to me. 

Describe the purpose and details of each pull request. 

If a PR is waiting for someone to review, highlight that in the response. 

If there were any check failures on the PR, describe them and suggest possible fixes. 

If there was no review done by Copilot, offer to request one using #request_copilot_review.

他には以下のようなものがあります。

  • Pythonチュートリアル

    • 初心者向けにコードにコメントアウトを追加
    • チュートリアル用のREADMEを作成

  • 仕様作成

    • 生成系AIが使用しやすいようにMarkdownのような構造化された形式で仕様書を作成

Custom Chat Modes: .github/chatmodes/*.md

通常用意されているAsk, Edit, Agent以外にユーザー定義の新たなモードを定義することができる機能。
.github/chatmodes/*.mdの形式でカスタムチャットモードファイルを保存したファイルすることカスタムモードの追加が可能。
カスタムチャットモード名はファイルの名称が採用されます。

以下の例ではプルリクエストを操作するためのプロンプトを記載しています。

---
mode: agent

tools: ['githubRepo', 'github', 'get_me', 'get_pull_request', 'get_pull_request_comments', 'get_pull_request_diff', 'get_pull_request_files', 'get_pull_request_reviews', 'get_pull_request_status', 'list_pull_requests', 'request_copilot_review'] 

description: "List my pull requests in the current repository" 
---

Search the current repo (using #githubRepo for the repo info) and list any pull requests you find (using #list_pull_requests) that are assigned to me. 
Describe the purpose and details of each pull request. 
If a PR is waiting for someone to review, highlight that in the response. 
If there were any check failures on the PR, describe them and suggest possible fixes. 
If there was no review done by Copilot, offer to request one using #request_copilot_review.

以下の例ではPostgreSQL データベース管理者（DBA）として、pgsqlなどツールを使って、テーブル作成やバックアップ、パフォーマンスの改善、セキュリティ対策などを行うエージェンモードを定義しています。

---
description: 'Work with PostgreSQL databases using the PostgreSQL extension.'
tools: ['codebase', 'editFiles', 'githubRepo', 'runCommands', 'database', 'pgsql_bulkLoadCsv', 'pgsql_connect', 'pgsql_describeCsv', 'pgsql_disconnect', 'pgsql_listDatabases', 'pgsql_listServers', 'pgsql_modifyDatabase', 'pgsql_open_script', 'pgsql_query', 'pgsql_visualizeSchema']
---

# Database Administrator Chat Mode

You are a PostgreSQL Database Administrator (DBA) with expertise in managing and maintaining PostgreSQL database systems. You can perform tasks such as:
- Creating and managing databases
- Writing and optimizing SQL queries
- Performing database backups and restores
- Monitoring database performance
- Implementing security measures

You have access to various tools that allow you to interact with databases, execute queries, and manage database configurations. **Always** use the tools to inspect the database, do not look into the codebase.

他には以下のようなものがあります。

  • 4.1 ビーストモード(VS Code v1.102)

    • 完全に問題を解決するまでユーザーに応答しないように強化されたエージェントモード
      • タスク完遂のためにTODOリストを作成し、TODOリストが完了するまでユーザーに応答を返さない
      • LLMの知識が古いという前提で、FetchでWEBから最新情報を取得

  • Azure プリンシパル アーキテクト モード

    • Azure Well-Architected Framework (WAF) の原則と Microsoftのベストプラクティスを使用して、Azureアーキテクチャガイダンスを提供する

チートシート

Visual Studio Code拡張機能のコマンド一覧

基本操作

コマンド ショートカットキー
提案を受入れる < Tab >
提案を拒否する < Esc >
補完パネルを表示 < Ctrl + Enter >
単語単位で提案を受け入れる < Ctrl + → >
次の提案を表示 < Alt + ] >
前の提案を表示 < Alt + [ >
インラインチャットの表示 < Ctrl + i >
クイックチャットの表示 < Ctrl + Shift + i >
チャットビューの表示 < Ctrl + Alt + i >

Copilot Chatで使用することができるコマンド

以下はCopilot Chatで使用することができるコマンドです。

@コマンド スラッシュコマンド 説明
/help Copilotの使い方について説明する
/clear 既存のチャット履歴を削除し、新しいチャット履歴を表示
@workspace /explain 選択したコードの動作を説明する
/tests 選択したコードのユニットテストを生成する
/fix 選択したコードの問題を修正する提案をする
/new 新しいプロジェクトやファイルをスキャフォールド（雛形を作成）
/newNotebook 新しいJupyter Notebookを作成する
@vscode /api VS Codeの拡張開発について質問する
@terminal ターミナルでの操作方法について質問する
変数 説明
#editor アクティブなエディタに表示されているソースコードをプロンプトとして入力
#selection アクティブなエディタの現在の選択範囲をプロンプトとして入力
#terminalLastCommand アクティブなターミナルの最後に実行したコマンドをプロンプトとして入力
#terminalSelection アクティブなターミナルの選択範囲をプロンプトとして入力

Zenn:Github Copilotの基本的な使い方

コマンドパレット

Ctrl + Shift + P を実行すると、コマンドパレットが表示され、使用できるコマンドの一覧が表示されます。

コマンド ショートカットキー 内容
Chat: Open Quick Chat チャットウィンドウを画面上部に素早く開きます。
Chat: Open Editor チャットエディタをエディタの新しいタブで開きます。
Chat: Focus on GitHub Copilot on View 画面左側のGitHub Copilotのビューにフォーカスを移動します。
GitHub Copilot: Apply Suggestion with Copilot GitHub Copilotによる提案を適用する? ※ tabキーの押下で実施可能な模様
GitHub Copilot: Accept panel suggestion at the cursor <Ctrl + /> カーソル位置のパネル提案を受け入れる?
GitHub Copilot: Collect Diagnostics 診断情報を収集します。
GitHub Copilot: Explain This 選択したコードの説明をビューに表示します。
GitHub Copilot: Explain This (Terminal) ターミナルで選択したコマンドの説明を提供します。
GitHub Copilot: Explain Last Command (Terminal) ターミナルで最後に実行したコマンドの説明を提供します。
GitHub Copilot: EnabIe/DisabIe Copilot completions GitHub Copilotの補完機能を有効/無効にします。
GitHub Copilot: Fix This 選択したコードの問題を修正する提案をします。
GitHub Copilot: Generate Docs 選択したコードにコメントを生成します。
GitHub Copilot: Generate Tests 選択したコードのユニットテストを生成します。
GitHub Copilot: Navigate to the next panel suggestion <Alt + ]> 次のパネル提案に移動します。
GitHub Copilot: Navigate to the previous panel suggestion <Alt + [> 前のパネル提案に移動します。
GitHub Copilot: Open Completions Panel <Ctrl + Enter> 補完パネルを開きます。
GitHub Copilot: Open Logs ログを開きます。
GitHub Copilot: Send Chat Feedback チャットに関するフィードバックを送信します。
GitHub Copilot: Send Feedback 一般的なフィードバックを送信します。
GitHub Copilot: Suggest Terminal Command <Ctrl + 8> ターミナルコマンドの提案をします。

Jetbrains拡張機能のコマンド一覧

基本操作

コマンド ショートカットキー
提案を受入れる < Tab >
提案を拒否する < Esc >
次の提案を表示 < Alt + ] > or < Ctrl + , >
前の提案を表示 < Alt + [ > or < Ctrl + . >
サイドバーのチャットパネルの表示 < Ctrl + Shift + C >

Copilot Chatで使用することができるコマンド

以下はCopilot Chatで使用することができるコマンドです。

スラッシュコマンド 説明
/help Copilotの使い方を説明
/explain 選択したコードの動作を説明する
/tests 選択したコードのユニットテストを生成する
/fix 選択したコードの問題を修正する提案をする
/simplify 対象コードから不要な処理を除外したシンプルなコードの提案を依頼
/feedback フィードバックをフォーラムに投稿するための識別子を生成

アクション

Jetbrains IDEではCtrl + Shift + AでJetbrains IDEで使用できるコマンドを検索できるFind Actionsウィンドウを検索できる。
Find ActionsでCopilotと検索すると、Copilot拡張機能で使用できるコマンドが確認できます。

コマンド ショートカットキー 内容
Copilot: Enable Completions < Ctrl + Alt + Shift + O > Copilotによる提案を有効化
Copilot: Disable Completions < Ctrl + Alt + Shift + O > Copilotによる提案を無効化
Copilot: Disable Completions for Python CopilotによるPythonの提案を無効化
Copilot: Edit Keyboard Shortcuts ショートカットキーの変更
Copilot: GitHub Copilot Chat 右側サイドバーのCopilot Chatを表示
Copilot: Open Completions 右側サイドバーのCompletionsウィンドウを表示
Copilot: Open Settings Copilotの設定画面を表示
Copilot: Show GitHub Copilot Status Copilotのステータスを表示。画面右下のステータスバーのCopilotのクリックと同義
Copilot: Show Completions < Alt + \ > Copilotの提案を表示
Copilot: Show Previous Completions < Alt + [, Ctrl + , > Copilotの前の提案を表示
Copilot: Show Next Completions < Alt + ], Ctrl + . > Copilotの次の提案を表示
Copilot: Log Diagnostics 診断ログを表示
Copilot: Log CA Certificates ログを表示
Copilot: Logout from GitHub GitHubからログアウト
Copilot: Login to GitHub GitHubにログイン
Copilot: View Feedback Forum フィードバックフォーラムのWEBページを表示
Copilot: View GitHub Documentation ドキュメントのWEBページを表示
Copilot: View Welcome Guide 左側のサイドバーにウェルカムメッセージを表示
Open GitHub Copilot Chat < Ctrl + Shift + C > 右側サイドバーのCopilot Chatを表示
GitHub Copilot 右側サイドバーのCompletionsウィンドウを表示
GitHub Copilot※同名コマンド Copilotコマンド一覧ウィンドウを表示
GitHub Copilot Chat 右側サイドバーのCopilot Chatを表示
GitHub Copilot(Settings > Plugin) JetBrainsのPluginの設定の表示
GitHub Copilot notifications(Settings > Notifications > ON/OFF) Copilotの通知の設定
Plugins: GitHub Copliot CopilotプラグインのOn/Offを切り替える
Show Github Copilot 右下のステータスバーのCopilotの表示/非表示を切り替える
Welcom to GitHub Copilot 左側のサイドバーにウェルカムメッセージを表示

参考

おわりに

Github Copilotを上手に活用することで、コーディングの効率を大幅に向上させることができます。
これらの基本的な使い方やコツを参考に、Github Copilotを最大限に活用してみてください。

本サイトへのご意見、お問い合わせなどありましたらこちらからご連絡下さい。 お問合せフォーム