VS Code における GitHub Copilot の設定リファレンス

この記事では、Visual Studio Code における GitHub Copilot の構成設定について説明します。VS Code での設定の一般的な操作については、「ユーザー設定とワークスペース設定」と、定義済み変数のサポートに関する情報については、「変数リファレンス」を参照してください。

ヒント

Copilot サブスクリプションをまだお持ちでない場合は、Copilot Free プランにサインアップして、毎月の補完とチャットインタラクションの制限内で Copilot を無料で使用できます。

チームは、VS Code における Copilot の改善と新機能の追加に継続的に取り組んでいます。一部の機能はまだ試験段階です。ぜひお試しいただき、issue でフィードバックをお寄せください。VS Code の機能ライフサイクルの詳細をご覧ください。

一般設定

github.copilot.editor.enableAutoCompletions: インライン補完を自動的に表示します。
github.copilot.enable: 指定された言語に対して Copilot 補完を有効または無効にします。
github.copilot.editor.enableCodeActions: Copilot コマンドが利用可能な場合にコードアクションとして表示するかどうかを制御します。
github.copilot.renameSuggestions.triggerAutomatically: Copilot が名前変更の候補を生成するかどうかを制御します。
chat.commandCenter.enabled: VS Code タイトルバーに Copilot メニューを表示するかどうかを制御します (既定値: true)。
github.copilot.nextEditSuggestions.enabled: Copilot Next Edit Suggestions (Copilot NES) を有効にします。
editor.inlineSuggest.edits.allowCodeShifting: Copilot NES が提案を表示するためにコードをシフトできるかどうかを構成します。
editor.inlineSuggest.edits.renderSideBySide: Copilot NES が可能な場合は大きな提案を並べて表示するか、Copilot NES が常に大きな提案を関連するコードの下に表示するかを構成します。
workbench.commandPalette.experimental.askChatLocation (試験的): コマンドパレットがチャットの質問をする場所を制御します。
github.copilot.chat.search.semanticTextResults (試験的): 検索ビューでセマンティック検索結果を有効にします。
chat.setupFromDialog (試験的): チャットセッションを開始するときに Copilot セットアップダイアログを表示するかどうかを制御します。

チャット設定

github.copilot.chat.followUps: Copilot がチャットでフォローアップの質問を提案するかどうかを制御します。
github.copilot.chat.localeOverride: Copilot が応答するロケール (en や fr など) を指定します。
github.copilot.chat.runCommand.enabled: チャットビューで VS Code コマンドを実行するための /runCommand インテントを有効にします。
github.copilot.chat.useProjectTemplates: /new を使用する場合、関連する GitHub プロジェクトをスタータープロジェクトとして使用します。
github.copilot.chat.scopeSelection: /explain を使用し、アクティブなエディターに選択範囲がない場合に、特定のシンボルスコープのプロンプトを表示するかどうか。
github.copilot.chat.terminalChatLocation: ターミナルからのチャットクエリをどこで開くかを制御します。
chat.detectParticipant.enabled: チャットビューでチャット参加者の検出を有効にします。
chat.editor.fontFamily: チャットコードブロックのフォントファミリー。
chat.editor.fontSize: チャットコードブロックのフォントサイズ (ピクセル単位)。
chat.editor.fontWeight: チャットコードブロックのフォントの太さ。
chat.editor.lineHeight: チャットコードブロックの行の高さ (ピクセル単位)。
chat.editor.wordWrap: チャットコードブロックで行の折り返しを切り替えます。
chat.editing.confirmEditRequestRemoval: 編集を元に戻す前に確認を求めます (既定値: true)
chat.editing.confirmEditRequestRetry: 最後に行った編集のやり直しを実行する前に確認を求めます (既定値: true)
chat.editing.autoAcceptDelay: 提案された編集が自動的に受け入れられるまでの遅延を構成します。自動受け入れを無効にするには 0 を使用します (既定値: 0)
chat.agent.enabled: エージェントモードを有効または無効にします (既定値: false)
chat.agent.maxRequests: エージェントモードで Copilot が行えるリクエストの最大数 (既定値: 15)
github.copilot.chat.agent.runTasks: エージェントモードを使用するときにワークスペースタスクを実行します (既定値: true)
github.copilot.chat.codesearch.enabled (プレビュー): プロンプトで #codebase を使用すると、Copilot は編集する関連ファイルを自動的に検出します。
chat.implicitContext.enabled (試験的): アクティブなエディターをチャットプロンプトのコンテキストとして自動的に追加するかどうかを構成します。
github.copilot.chat.agent.thinkingTool (試験的): エージェントモードで思考ツールを有効にします。
github.copilot.chat.newWorkspaceCreation.enabled (試験的): チャットで新しいワークスペースをスキャフォールディングするためのエージェントモードツールを有効にします。
github.copilot.chat.edits.temporalContext.enabled (試験的): Copilot Edits でのリクエストに、最近表示および編集したファイルを含めるかどうか。
github.copilot.chat.edits.suggestRelatedFilesFromGitHistory (試験的): Copilot Edits で Git 履歴から関連ファイルを提案します (既定値: false)

インラインチャット設定

inlineChat.acceptedOrDiscardBeforeSave: エディターで保留中のインラインチャットセッションがファイルの保存を妨げるかどうかを制御します。
inlineChat.finishOnType: 変更された領域の外側で入力するときにインラインチャットセッションを終了するかどうか。
inlineChat.holdToSpeech: インラインチャットのキーボードショートカットを長押しすると、音声認識が自動的に有効になるかどうか。
inlineChat.lineEmptyHint (試験的): 空行にインラインチャットのヒントを表示するかどうかを制御します。
inlineChat.lineNaturalLanguageHint (試験的): 行がほとんど単語で構成されるとすぐにインラインチャットをトリガーする試験的な提案。
editor.inlineSuggest.syntaxHighlightingEnabled: インライン候補の構文の強調表示を表示するかどうかを制御します。
github.copilot.chat.editor.temporalContext.enabled (試験的): インラインチャットでの Copilot リクエストに、最近表示および編集したファイルを含めるかどうか。

Copilot プロンプトのカスタマイズ

github.copilot.chat.codeGeneration.useInstructionFiles: .github/copilot-instructions.md からのコード指示を Copilot リクエストに追加するかどうかを制御します。
github.copilot.chat.reviewSelection.enabled (プレビュー): エディターテキスト選択のコードレビューを有効にします。
github.copilot.chat.reviewSelection.instructions (プレビュー): 現在のエディター選択をレビューするために Copilot リクエストに追加される一連の指示。
github.copilot.chat.codeGeneration.instructions (試験的): コードを生成する Copilot リクエストに追加される一連の指示。
github.copilot.chat.testGeneration.instructions (試験的): テストを生成する Copilot リクエストに追加される一連の指示。
github.copilot.chat.commitMessageGeneration.instructions (試験的): コミットメッセージを生成する Copilot リクエストに追加される一連の指示。現在エディターで選択されている内容をレビューするための Copilot リクエスト。
github.copilot.chat.pullRequestDescriptionGeneration.instructions (試験的): プルリクエストのタイトルと説明を生成する Copilot リクエストに追加される一連の指示。
chat.promptFiles (試験的): 再利用可能なプロンプトファイルを有効または無効にします。
chat.promptFilesLocations (試験的): プロンプトファイルの場所を指定します。既定の場所 (.github/prompts) を使用するには true に設定するか、{ "/path/to/folder": boolean } 表記を使用して別のパスを指定します。相対パスは、ワークスペースのルートフォルダーから解決されます。

デバッグ設定

github.copilot.chat.startDebugging.enabled (プレビュー): チャットビューでデバッグ構成を生成するための試験的な /startDebugging インテントを有効にします。
github.copilot.chat.copilotDebugCommand.enabled (プレビュー): copilot-debug ターミナルコマンドを有効にします。

テスト設定

github.copilot.chat.generateTests.codeLens (試験的): 現在のテストカバレッジ情報でカバーされていないシンボルに対して、テストの生成 コードレンズを表示します。
github.copilot.chat.setupTests.enabled (試験的): 試験的な /setupTests インテントと /tests 生成でのプロンプトを有効にします。
github.copilot.chat.testGeneration.instructions (試験的): テストを生成する Copilot リクエストに追加される一連の指示。

ノートブック設定

notebook.experimental.generate (試験的): ノートブックエディターでインラインチャットを有効にしてコードセルを作成するための生成アクションを有効にします。

アクセシビリティ設定

inlineChat.accessibleDiffView: インラインチャットが変更のアクセシブルな差分ビューアーもレンダリングするかどうか。
accessibility.signals.chatRequestSent: チャットリクエストが行われたときに、信号 - サウンド (オーディオキュー) および/またはアナウンス (アラート) - を再生します。
accessibility.signals.chatResponseReceived: レスポンスが受信されたときにサウンド/オーディオキューを再生します。
accessibility.verbosity.inlineChat: インラインエディターチャットのアクセシビリティヘルプメニューへのアクセス方法に関する情報を提供し、入力にフォーカスがあるときに機能の使用方法を説明するヒントで警告します。
accessibility.verbosity.inlineCompletions: インライン補完のホバーとアクセシブルビューへのアクセス方法に関する情報を提供します。
accessibility.verbosity.panelChat: チャット入力にフォーカスがあるときにチャットヘルプメニューへのアクセス方法に関する情報を提供します。
accessibility.voice.keywordActivation: 音声チャットセッションを開始するためにキーワードフレーズ「Hey Code」が認識されるかどうかを制御します。
accessibility.voice.autoSynthesize: 音声が入力として使用されたときに、テキスト応答を自動的に読み上げるかどうかを制御します。
accessibility.voice.speechTimeout: 発話を停止してから音声認識がアクティブなままになる時間 (ミリ秒単位)。