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
title: Configuring GitHub Copilot in a JetBrains IDE
3
+
intro: 'You can enable, configure, and disable {% data variables.product.prodname_copilot %} in a JetBrains IDE.'
4
+
product: '{% data reusables.gated-features.copilot %}'
5
+
topics:
6
+
- Copilot
7
+
versions:
8
+
feature: 'copilot'
9
+
shortTitle: JetBrains
10
+
---
11
+
12
+
## About {% data variables.product.prodname_copilot %} in JetBrains IDEs
13
+
14
+
If you use a Jetbrains IDE, {% data variables.product.prodname_copilot %} can autocomplete code as you type. After installation, you can enable or disable {% data variables.product.prodname_copilot %}, and you can configure advanced settings within your IDE or on {% data variables.product.prodname_dotcom_the_website %}.
15
+
16
+
## Prerequisites
17
+
18
+
To configure {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[Getting started with {% data variables.product.prodname_copilot %} in a JetBrains IDE](/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide)."
19
+
20
+
## Keyboard shortcuts for {% data variables.product.prodname_copilot %}
21
+
22
+
You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command. For more information on rebinding keyboard shortcuts in your JetBrains IDE, see the JetBrains documentation. For example, you can view the [IntelliJ IDEA](https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html#choose-keymap) documentation.
23
+
24
+
{% mac %}
25
+
26
+
| Action | Shortcut |
27
+
|:---|:---|
28
+
|Accept an inline suggestion|<kbd>Tab</kbd>|
29
+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
30
+
|Show next inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>]</kbd>|
31
+
|Show previous inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>[</kbd>|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Alt</kbd>+<kbd>Enter</kbd> |
60
+
61
+
{% endlinux %}
62
+
63
+
## Enabling or disabling {% data variables.product.prodname_copilot %}
64
+
65
+
You can enable or disable {% data variables.product.prodname_copilot %} from within your JetBrains IDE. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the JetBrains window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.
66
+
67
+
1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the JetBrains window.
68
+
69
+
2. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing. To disable globally, click **Disable Completions**. Alternatively, click the language-specific button to disable {% data variables.product.prodname_copilot %} for the specified language.
70
+
71
+
72
+
## Configuring advanced settings for {% data variables.product.prodname_copilot %}
73
+
74
+
You can manage advanced settings for {% data variables.product.prodname_copilot %} in your JetBrains IDE, such as how your IDE displays code completions, and which languages you want to enable or disable for {% data variables.product.prodname_copilot %}.
75
+
76
+
1. In your JetBrains IDE, click the **File** menu, then click **Settings**.
77
+
1. Under **Languages & Frameworks**, click **{% data variables.product.prodname_copilot %}**.
78
+
1. Edit the settings according to your personal preferences.
79
+
- To adjust the behaviour and appearance of code suggestions, and whether to automatically check for updates, select or deselect the corresponding checkboxes.
80
+
- If you have selected to receive automatic updates, you can choose whether to receive stable, but less frequent updates, or nightly updates, which may be less stable. Click the **Update channel** dropdown and select **Stable** for stable updates, or **Nightly** for nightly updates.
81
+
- Under "Disabled languages", use the checkboxes to select or deselect the languages you want to disable {% data variables.product.prodname_copilot %} for.
Copy file name to clipboardExpand all lines: content/copilot/configuring-github-copilot/configuring-github-copilot-in-visual-studio-code.md
+71-14Lines changed: 71 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,55 +9,112 @@ topics:
9
9
- Copilot
10
10
---
11
11
12
+
## About {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}
13
+
14
+
If you use {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_copilot %} can autocomplete code as you type. After installation, you can enable or disable {% data variables.product.prodname_copilot %}, and you can configure advanced settings within {% data variables.product.prodname_vscode %} or on {% data variables.product.prodname_dotcom_the_website %}.
15
+
16
+
## Prerequisites
17
+
18
+
To configure {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[Getting started with {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-stuido-code)."
19
+
12
20
## Keyboard shortcuts for {% data variables.product.prodname_copilot %}
13
21
14
22
You can use the default keyboard shortcuts in {% data variables.product.prodname_vscode %} when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts in the Keyboard Shortcuts editor using your preferred keyboard shortcuts for each specific command. You can search for each keyboard shortcut by command name in the Keyboard Shortcuts editor.
15
23
24
+
{% mac %}
25
+
26
+
| Action | Shortcut | Command name |
27
+
|:---|:---|:---|
28
+
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
29
+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
30
+
|Show next inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>]</kbd><br> |editor.action.inlineSuggest.showNext|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Return</kbd>|github.copilot.generate|
34
+
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
35
+
36
+
{% endmac %}
37
+
38
+
{% windows %}
39
+
16
40
| Action | Shortcut | Command name |
17
41
|:---|:---|:---|
18
42
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
19
43
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
20
-
|Show next inline suggestion|On macOS: <kbd>Option (⌥)</kbd>+<kbd>]</kbd><br> On Windows or Linux: <kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
21
-
|Show previous inline suggestion|On macOS: <kbd>Option (⌥)</kbd>+<kbd>[</kbd><br> On Windows or Linux: <kbd>Alt</kbd>+<kbd>[</kbd>|editor.action.inlineSuggest.showPrevious|
22
-
|Trigger inline suggestion|On macOS: <kbd>Option (⌥)</kbd>+<kbd>\</kbd><br> On Windows or Linux: <kbd>Alt</kbd>+<kbd>\</kbd>|editor.action.inlineSuggest.trigger|
44
+
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
24
48
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
25
49
50
+
{% endwindows %}
51
+
52
+
53
+
{% linux %}
54
+
55
+
| Action | Shortcut | Command name |
56
+
|:---|:---|:---|
57
+
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
58
+
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
59
+
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
63
+
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
64
+
65
+
{% endlinux %}
66
+
26
67
## Rebinding keyboard shortcuts
27
68
69
+
If you don't want to use the default keyboard shortcuts in {% data variables.product.prodname_vscode %} when using {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Keyboard Shortcuts editor using your preferred keyboard shortcuts for each specific command.
70
+
28
71
1. Click the **File** menu, click **Preferences**, then click **Keyboard Shortcuts**.
29
-
72
+
30
73
1. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.
36
79
37
80
## Enabling or disabling {% data variables.product.prodname_copilot %}
38
81
39
82
You can enable or disable {% data variables.product.prodname_copilot %} from within {% data variables.product.prodname_vscode %}. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the {% data variables.product.prodname_vscode %} window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the background color of the icon will match the color of the status bar. When disabled, the background color of the icon will contrast the color of the status bar.
40
83
41
84
1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the {% data variables.product.prodname_vscode %} window.
42
-
85
+
43
86
2. If you are disabling {% data variables.product.prodname_copilot %}, Visual Studio Code will ask whether you want to disable it globally, or only for the language of the file you are currently editing. To disable globally, click **Disable globally**. Alternatively, click the language-specific button to disable {% data variables.product.prodname_copilot %} for the specified language.
44
-
87
+
45
88
46
89
## Enabling or disabling inline suggestions
47
90
48
-
You can choose to enable or disable inline suggestions in Visual Studio Code.
91
+
You can choose to enable or disable inline suggestions for {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}.
49
92
50
93
1. In the **File** menu, navigate to **Preferences** and click **Settings**.
51
-
94
+
52
95
1. In the left-side panel of the settings tab, click **Extensions** and then select **Copilot**.
53
-
1. Under "Inline Suggest:Enabled", select or deselect to enable or disable inline suggestions.
96
+
1. Under "Inline Suggest:Enable", select or deselect the checkbox to enable or disable inline suggestions.
54
97
55
98
## Enabling or disabling {% data variables.product.prodname_copilot %} for specific languages
56
99
57
100
You can specify which languages you want to enable or disable {% data variables.product.prodname_copilot %} for.
58
101
59
-
1.Display the **Copilot** section in the **Extensions** tab of the Visual Studio Code settings page. For more information, see "[Enabling and disabling inline suggestions](#enabling-and-disabling-inline-suggestions)."
102
+
1.From the {% data variables.product.prodname_vscode %}, click the **Extensions** tab, then navigate to the **Copilot** section. For more information, see "[Enabling and disabling inline suggestions](#enabling-and-disabling-inline-suggestions)."
60
103
1. Under "Enable or disable Copilot for specified languages", click **Edit in settings.json**.
61
-
1. In the settings.json file, add or remove the languages for which you want to enable or disable {% data variables.product.prodname_copilot %}. For example, to enable Python in {% data variables.product.prodname_copilot %}, add `"python": true` to the JSON list.
104
+
1. In the _settings.json_ file, add or remove the languages you want to enable or disable {% data variables.product.prodname_copilot %} for. For example, to enable Python in {% data variables.product.prodname_copilot %}, add `"python": true` to the list, ensuring there is a trailing comma after all but the last list item.
0 commit comments