is now available! Read about the new features and fixes from October.

GitHub Copilot in VS Code settings reference

This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to User and workspace settings, as well as the Variables reference for information about predefined variable support.

The team is continuously working on improving Copilot in VS Code and adding new features. Items marked with are experimental features. Try them out and share your feedback in our issues. Get more info about the feature lifecycle in VS Code.

General settings

  • github.copilot.editor.enableAutoCompletions: Automatically show inline completions.
  • github.copilot.enable: Enable or disable Copilot completions for specified languages.
  • github.copilot.editor.enableCodeActions: Controls if Copilot commands are shown as Code Actions when available.
  • github.copilot.renameSuggestions.triggerAutomatically: Controls whether Copilot generates suggestions for renaming.
  • chat.commandCenter.enabled : Controls whether the command center shows a menu for chat actions.
  • workbench.commandPalette.experimental.askChatLocation : Controls where the Command Palette should ask chat questions.
  • github.copilot.chat.search.semanticTextResults : Enables semantic search results in the Search view.

Chat settings

  • github.copilot.chat.followUps: Controls whether Copilot should suggest follow-up questions in chat.
  • github.copilot.chat.localeOverride: Specify a locale that Copilot should respond in, such as en or fr.
  • github.copilot.chat.runCommand.enabled: Enables the /runCommand intent in the Chat view to run VS Code commands.
  • github.copilot.chat.useProjectTemplates: Use relevant GitHub projects as starter projects when using /new.
  • github.copilot.chat.scopeSelection: Whether to prompt for a specific symbol scope if you use /explain and the active editor has no selection.
  • github.copilot.chat.terminalChatLocation: Controls where chat queries from the terminal should be opened.
  • chat.experimental.detectParticipant.enabled : Enable chat participant detection in the Chat view.
  • chat.editor.fontFamily: Font family in chat codeblocks.
  • chat.editor.fontSize: Font size in pixels in chat codeblocks.
  • chat.editor.fontWeight: Font weight in chat codeblocks.
  • chat.editor.lineHeight: Line height in pixels in chat codeblocks.
  • chat.editor.wordWrap: Toggle line wrapping in chat codeblocks.

Edits settings

  • github.copilot.chat.edits.enabled (Preview) - enable or disable Copilot Edits
  • chat.editing.confirmEditRequestRemoval - ask for confirmation before undoing an edit (default: true)
  • chat.editing.confirmEditRequestRetry - ask for confirmation before performing a redo of the last edit (default: true)
  • chat.editing.alwaysSaveWithGeneratedChanges - automatically save generated changes from Copilot Edits to disk (default: false)

Inline Chat settings

  • inlineChat.acceptedOrDiscardBeforeSave: Controls whether pending Inline Chat sessions in an editor prevent saving the file.
  • inlineChat.finishOnType: Whether to finish an Inline Chat session when typing outside of changed regions.
  • inlineChat.holdToSpeech: Whether holding the Inline Chat keybinding will automatically enable speech recognition.
  • inlineChat.mode: Configure if changes crafted with Inline Chat are applied directly to the document or are previewed first.
  • github.copilot.chat.inlineChatCompletionTrigger.enabled : Experimental suggestion that triggers Inline Chat as soon as a line mostly consists of words.
  • github.copilot.chat.inlineChatHint.enabled : Hint for Inline Chat that shows once a line mostly consists of words.
  • github.copilot.chat.temporalContext.enabled : Whether to include recently viewed and edited files with Copilot requests in Inline Chat.

Customize Copilot prompts

  • github.copilot.chat.codeGeneration.instructions : A set of instructions that will be added to Copilot requests that generate code.
  • github.copilot.chat.codeGeneration.useInstructionFiles (Preview): Controls whether code instructions from .github/copilot-instructions.md are added to Copilot requests.
  • github.copilot.chat.testGeneration.instructions : A set of instructions that will be added to Copilot requests that generate tests.
  • github.copilot.chat.reviewSelection.instructions (Preview): A set of instructions that will be added to Copilot requests for reviewing the current editor selection.

Debugging settings

  • github.copilot.chat.startDebugging.enabled (Preview): Enables the experimental /startDebugging intent in the Chat view to generate debugging configuration.

Testing settings

  • github.copilot.chat.generateTests.codeLens : Show Generate tests code lens for symbols that are not covered by current test coverage information.
  • github.copilot.chat.setupTests.enabled : Enables the experimental /setupTests intent and prompting in /tests generation.
  • github.copilot.chat.fixTestFailure.enabled: Enables the preview /fixTestFailure intent in chat and delegates certain /fix invocations automatically if no testing setup is found.
  • github.copilot.chat.testGeneration.instructions : A set of instructions that will be added to Copilot requests that generate tests.

Notebook settings

  • notebook.experimental.generate : Enable the Generate action to create code cells with Inline Chat enabled in the notebook editor.

Accessibility settings

  • inlineChat.accessibleDiffView: Whether the Inline Chat also renders an accessible diff viewer for its changes.
  • accessibility.signals.chatRequestSent: Plays a signal - sound (audio cue) and/or announcement (alert) - when a chat request is made.
  • accessibility.signals.chatResponseReceived: Plays a sound / audio cue when the response has been received.
  • accessibility.verbosity.inlineChat: Provide information about how to access the inline editor chat accessibility help menu and alert with hints that describe how to use the feature when the input is focused.
  • accessibility.verbosity.inlineCompletions: Provide information about how to access the inline completions hover and Accessible View.
  • accessibility.verbosity.panelChat: Provide information about how to access the chat help menu when the chat input is focused.
  • accessibility.voice.keywordActivation: Controls whether the keyword phrase 'Hey Code' is recognized to start a voice chat session.
  • accessibility.voice.autoSynthesize: Controls whether a textual response should automatically be read out aloud when speech was used as input.
  • accessibility.voice.speechTimeout: The duration in milliseconds that voice speech recognition remains active after you stop speaking.

Related resources

10/29/2024