You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/copilot/copilot-settings.md
+44-26Lines changed: 44 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
Order: 11
2
+
Order: 12
3
3
Area: copilot
4
4
TOCTitle: Settings Reference
5
5
ContentId: 7b232695-cbbe-4f3f-a625-abc7a5e6496c
@@ -22,47 +22,65 @@ The team is continuously working on improving Copilot in VS Code and adding new
22
22
*`setting(github.copilot.renameSuggestions.triggerAutomatically)`: Controls whether Copilot generates suggestions for renaming.
23
23
*`setting(chat.commandCenter.enabled)` <iclass="codicon codicon-beaker"></i>: Controls whether the command center shows a menu for chat actions.
24
24
*`setting(workbench.commandPalette.experimental.askChatLocation)` <iclass="codicon codicon-beaker"></i>: Controls where the Command Palette should ask chat questions.
25
-
*`setting(github.copilot.chat.search.semanticTextResults)`_(Preview)_: Enables semantic search results in the Search view.
25
+
*`setting(github.copilot.chat.search.semanticTextResults)`<iclass="codicon codicon-beaker"></i>: Enables semantic search results in the Search view.
26
26
27
27
## Chat settings
28
28
29
-
*`setting(chat.editor.fontFamily)`: Font family in chat codeblocks.
30
-
*`setting(chat.editor.fontSize)`: Font size in pixels in chat codeblocks.
31
-
*`setting(chat.editor.fontWeight)`: Font weight in chat codeblocks.
32
-
*`setting(chat.editor.lineHeight)`: Line height in pixels in chat codeblocks - use 0 to compute the line height from the font size.
33
-
*`setting(chat.editor.wordWrap)`: Configure line wrapping in chat codeblocks.
29
+
*`setting(github.copilot.chat.followUps)`: Controls whether Copilot should suggest follow-up questions in chat.
34
30
*`setting(github.copilot.chat.localeOverride)`: Specify a locale that Copilot should respond in, such as `en` or `fr`.
35
-
*`setting(github.copilot.chat.fixTestFailure.enabled)`: Enables the preview `/fixTestFailure` intent in chat and delegates certain `/fix` invocations automatically if no testing setup is found.
36
31
*`setting(github.copilot.chat.runCommand.enabled)`: Enables the `/runCommand` intent in the Chat view to run VS Code commands.
37
32
*`setting(github.copilot.chat.useProjectTemplates)`: Use relevant GitHub projects as starter projects when using `/new`.
33
+
*`setting(github.copilot.chat.scopeSelection)`: Whether to prompt for a specific symbol scope if you use `/explain` and the active editor has no selection.
38
34
*`setting(github.copilot.chat.terminalChatLocation)`: Controls where chat queries from the terminal should be opened.
39
-
*`setting(github.copilot.chat.scopeSelection)`: Whether to prompt the user to select a specific symbol scope if the user uses `/explain` and the active editor has no selection.
40
-
*`setting(github.copilot.chat.experimental.codeFeedback.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that provide feedback for code.
41
-
*`setting(github.copilot.chat.experimental.codeGeneration.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that generate code.
42
-
*`setting(github.copilot.chat.experimental.testGeneration.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that generate tests.
43
-
*`setting(github.copilot.chat.experimental.codeGeneration.useInstructionFiles)` <iclass="codicon codicon-beaker"></i>: Controls whether code instructions from `.github/copilot-instructions.md` are added to Copilot requests.
44
-
*`setting(github.copilot.chat.experimental.generateTests.codeLens)` <iclass="codicon codicon-beaker"></i>: Show **Generate tests** code lens for symbols that are not covered by current test coverage information.
45
-
*`setting(github.copilot.chat.experimental.inlineChatCompletionTrigger.enabled)` <iclass="codicon codicon-beaker"></i>: Experimental suggestion that triggers inline chat as soon as a line mostly consists of words.
46
-
*`setting(github.copilot.chat.experimental.inlineChatHint.enabled)` <iclass="codicon codicon-beaker"></i>: Hint for inline chat that shows once a line mostly consists of words.
47
-
*`setting(github.copilot.chat.experimental.setupTests.enabled)` <iclass="codicon codicon-beaker"></i>: Enables the experimental `/setupTests` intent and prompting in `/tests` generation.
48
-
*`setting(github.copilot.chat.experimental.startDebugging.enabled)` <iclass="codicon codicon-beaker"></i>: Enables the experimental `/startDebugging` intent in the Chat view to generate debugging configuration.
49
-
*`setting(github.copilot.chat.experimental.temporalContext.enabled)` <iclass="codicon codicon-beaker"></i>: Whether to include recently viewed and edited files with Copilot requests in inline chat.
50
35
*`setting(chat.experimental.detectParticipant.enabled)` <iclass="codicon codicon-beaker"></i>: Enable chat participant detection in the Chat view.
36
+
*`setting(chat.editor.fontFamily)`: Font family in chat codeblocks.
37
+
*`setting(chat.editor.fontSize)`: Font size in pixels in chat codeblocks.
38
+
*`setting(chat.editor.fontWeight)`: Font weight in chat codeblocks.
39
+
*`setting(chat.editor.lineHeight)`: Line height in pixels in chat codeblocks.
40
+
*`setting(chat.editor.wordWrap)`: Toggle line wrapping in chat codeblocks.
41
+
42
+
## Edits settings
51
43
52
-
## Inline chat settings
44
+
*`setting(github.copilot.chat.edits.enabled)` - enable or disable Copilot Edits
45
+
*`setting(chat.editing.confirmEditRequestRemoval)` - ask for confirmation before undoing an edit (default: `true`)
46
+
*`setting(chat.editing.confirmEditRequestRetry)` - ask for confirmation before performing a redo of the last edit (default: `true`)
47
+
*`setting(chat.editing.alwaysSaveWithGeneratedChanges)` - automatically save generated changes from Copilot Edits to disk (default: `false`)
53
48
54
-
*`setting(inlineChat.acceptedOrDiscardBeforeSave)`: Controls whether pending inline chat sessions in an editor prevent saving the file.
55
-
*`setting(inlineChat.finishOnType)`: Whether to finish an inline chat session when typing outside of changed regions.
56
-
*`setting(inlineChat.holdToSpeech)`: Whether holding the inline chat keybinding will automatically enable speech recognition.
57
-
*`setting(inlineChat.mode)`: Configure if changes crafted with inline chat are applied directly to the document or are previewed first.
49
+
## Inline Chat settings
50
+
51
+
*`setting(inlineChat.acceptedOrDiscardBeforeSave)`: Controls whether pending Inline Chat sessions in an editor prevent saving the file.
52
+
*`setting(inlineChat.finishOnType)`: Whether to finish an Inline Chat session when typing outside of changed regions.
53
+
*`setting(inlineChat.holdToSpeech)`: Whether holding the Inline Chat keybinding will automatically enable speech recognition.
54
+
*`setting(inlineChat.mode)`: Configure if changes crafted with Inline Chat are applied directly to the document or are previewed first.
55
+
*`setting(github.copilot.chat.inlineChatCompletionTrigger.enabled)` <iclass="codicon codicon-beaker"></i>: Experimental suggestion that triggers Inline Chat as soon as a line mostly consists of words.
56
+
*`setting(github.copilot.chat.inlineChatHint.enabled)` <iclass="codicon codicon-beaker"></i>: Hint for Inline Chat that shows once a line mostly consists of words.
57
+
*`setting(github.copilot.chat.temporalContext.enabled)` <iclass="codicon codicon-beaker"></i>: Whether to include recently viewed and edited files with Copilot requests in Inline Chat.
58
+
59
+
## Customize Copilot prompts
60
+
61
+
*`setting(github.copilot.chat.codeGeneration.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that generate code.
62
+
*`setting(github.copilot.chat.codeGeneration.useInstructionFiles)`_(Preview)_: Controls whether code instructions from `.github/copilot-instructions.md` are added to Copilot requests.
63
+
*`setting(github.copilot.chat.testGeneration.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that generate tests.
64
+
*`setting(github.copilot.chat.reviewSelection.instructions)`_(Preview)_: A set of instructions that will be added to Copilot requests for reviewing the current editor selection.
65
+
66
+
## Debugging settings
67
+
68
+
*`setting(github.copilot.chat.startDebugging.enabled)`_(Preview)_: Enables the experimental `/startDebugging` intent in the Chat view to generate debugging configuration.
69
+
70
+
## Testing settings
71
+
72
+
*`setting(github.copilot.chat.generateTests.codeLens)` <iclass="codicon codicon-beaker"></i>: Show **Generate tests** code lens for symbols that are not covered by current test coverage information.
73
+
*`setting(github.copilot.chat.setupTests.enabled)` <iclass="codicon codicon-beaker"></i>: Enables the experimental `/setupTests` intent and prompting in `/tests` generation.
74
+
*`setting(github.copilot.chat.fixTestFailure.enabled)`: Enables the preview `/fixTestFailure` intent in chat and delegates certain `/fix` invocations automatically if no testing setup is found.
75
+
*`setting(github.copilot.chat.testGeneration.instructions)` <iclass="codicon codicon-beaker"></i>: A set of instructions that will be added to Copilot requests that generate tests.
58
76
59
77
## Notebook settings
60
78
61
-
*`setting(notebook.experimental.generate)` <iclass="codicon codicon-beaker"></i>: Enable the **Generate** action to create code cells with inline chat enabled in the notebook editor.
79
+
*`setting(notebook.experimental.generate)` <iclass="codicon codicon-beaker"></i>: Enable the **Generate** action to create code cells with Inline Chat enabled in the notebook editor.
62
80
63
81
## Accessibility settings
64
82
65
-
*`setting(inlineChat.accessibleDiffView)`: Whether the inline chat also renders an accessible diff viewer for its changes.
83
+
*`setting(inlineChat.accessibleDiffView)`: Whether the Inline Chat also renders an accessible diff viewer for its changes.
66
84
*`setting(accessibility.signals.chatRequestSent)`: Plays a signal - sound (audio cue) and/or announcement (alert) - when a chat request is made.
67
85
*`setting(accessibility.signals.chatResponseReceived)`: Plays a sound / audio cue when the response has been received.
68
86
*`setting(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.
Copy file name to clipboardExpand all lines: docs/copilot/copilot-vscode-features.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ Use natural language to chat with GitHub Copilot and get help with coding tasks.
23
23
| Action | Description |
24
24
|--------|-------------|
25
25
|`kb(workbench.action.chat.open)`| Open the **Chat view** and start a chat conversation with Copilot by using natural language. |
26
+
|`kb(workbench.action.chat.openEditSession)`| Open the **Copilot Edits view** and start a code editing session across multiple files. |
26
27
|`kb(workbench.action.quickchat.toggle)`| Open **Quick Chat** and ask a quick question to Copilot. |
27
28
|`kb(inlinechat.start)`| Start **Inline Chat** to send a chat request to Copilot directly from the editor. Use natural language or use `/` commands to give instructions to Copilot. |
28
29
| <iclass="codicon codicon-mention"></i> | Type `@` in chat or select <iclass="codicon codicon-mention"></i> to view the list of *chat participants*, which are domain experts that can help you in a specific area. Extensions can also contribute additional participants.<br/>Example: `@workspace how is auth implemented?`|
@@ -38,6 +39,27 @@ Use natural language to chat with GitHub Copilot and get help with coding tasks.
38
39
> - Be specific, keep it simple, and ask follow-up questions to get the best results.
39
40
> - Provide context by attaching files, symbols, or selections to your chat prompt.
40
41
42
+
## Code editing session
43
+
44
+
Use Copilot Edits to start a code editing session where you can iterate quickly on AI-generated code edits that are applied directly across multiple files in your workspace.
45
+
46
+
| Action | Description |
47
+
|--------|-------------|
48
+
|`kb(workbench.action.chat.openEditSession)`| Open the **Copilot Edits view** and start a code editing session across multiple files. |
49
+
| <iclass="codicon codicon-plus"></i> | Start a new edit session. |
50
+
|`Accept`| Accept all current edits. |
51
+
|`Discard`| Discard all current edits. |
52
+
| <iclass="codicon codicon-diff-multiple"></i> | View all edits in a multi-file diff editor. |
53
+
| <iclass="codicon codicon-discard"></i> | Undo the last edit. |
54
+
| <iclass="codicon codicon-redo"></i> | Redo the last edit. |
55
+
|`Add Files...`| Attach files to working set. |
56
+
57
+
> **Tips**
58
+
>
59
+
> - Add all files for which you want to get edits to the working set.
60
+
> - Be specific and precise about the changes you want Copilot Edits to make.
61
+
> - If you have a larger task, decompose it in smaller tasks and iterate often.
62
+
41
63
## Generate code from chat
42
64
43
65
Copilot can generate code blocks in response to your chat prompts. Quickly apply the generated code in your project or insert it in a new file. For example, ask Copilot to optimize an algorithm in your code.
0 commit comments