在环境中配置 Copilot

About Copilot in JetBrains IDEs

If you use a JetBrains IDE, Copilot can help you with a variety of tasks, including generating code suggestions, explaining how the code in your editor works, and suggesting code fixes. After installation, you can enable or disable Copilot, and you can configure advanced settings within your IDE or on . This article describes how to configure Copilot in the IntelliJ IDE, but the user interfaces of other JetBrains IDEs may differ.

Prerequisites

To configure Copilot in a JetBrains IDE, you must install the Copilot plugin. For more information, see Installing the Copilot extension in your environment.

Using or rebinding keyboard shortcuts for Copilot

You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using 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 documentation.

Keyboard shortcuts for macOS

Keyboard shortcuts for Windows

Keyboard shortcuts for Linux

Enabling or disabling Copilot

You can enable or disable Copilot from within your JetBrains IDE. The Copilot status icon in the bottom panel of the JetBrains window indicates whether Copilot is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.

1. To enable or disable Copilot, click the status icon in the bottom panel on the right of the JetBrains window.

   

2. If you are disabling 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 Copilot for the specified language.

   

Configuring advanced settings for Copilot

You can manage advanced settings for Copilot in your JetBrains IDE, such as how your IDE displays code completions, and which languages you want to enable or disable for Copilot.

1. In your JetBrains IDE, click the File menu (Windows), or the name of the application in the menu bar (macOS), then click Settings.
2. Under Languages & Frameworks, click Copilot.
3. Edit the settings according to your personal preferences.
   • To adjust the behavior and appearance of code suggestions, and whether to automatically check for updates, select or deselect the corresponding checkboxes.
   • 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.

Configuring language settings for Copilot

You can specify which languages you want to activate or deactivate Copilot for either in the IDE or by editing your -copilot.xml file. If you make changes to language settings in your IDE, you can individually select and deselect the languages you want to activate or deactivate.

If you make changes to the language settings in your -copilot.xml file, you can specify individual languages, or you can use a wildcard to activate or deactivate Copilot for all languages. You can also specify exceptions, which will override the wild card setting for the specified languages. For example, you can deactivate Copilot for all languages, except for Python and YAML. By default, when you install the Copilot extension, Copilot is activated for all languages.

Configuring language settings in the IDE

1. In your JetBrains IDE, click the File menu (Windows), or the name of the application in the menu bar (macOS), then click Settings.
2. Under Languages & Frameworks, click Copilot.
3. Under "Languages," select or deselect the checkboxes for the languages you want to activate or deactivate Copilot for.
4. Click Apply, and then click OK.
5. Restart your JetBrains IDE for the changes to take effect.

Editing your -copilot.xml file

To configure language settings in the -copilot.xml file, you must edit the languageAllowList. Every line you add to the languageAllowList must contain an entry key and a value. The entry key is the name of the language, or (*) for a wildcard. The value is either true or false. If the value is true, Copilot is activated for the specified language. If the value is false, Copilot is deactivated for the specified language.

The file is located in the following directory:

• macOS: ~/Library/Application Support/JetBrains/<product><version>/options/-copilot.xml
• Windows: %APPDATA%\JetBrains\<product><version>\options\-copilot.xml
• Linux: ~/.config/JetBrains/<product><version>/options/-copilot.xml

For example, if you are using IntelliJ IDEA 2021.1 on macOS, the file is located at ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/-copilot.xml.

The -copilot.xml file might not be generated until you make a change to your default language configuration in the IDE's settings. If you cannot locate the file, you should try modifying the default language settings in the IDE. For more information, see Configuring language settings in the IDE.

Alternatively, you can create the file manually and save it in the location for your operating system listed above. For more information, see Example language configurations.

1. Open the -copilot.xml file in a text editor.

2. Between the <map> tags, add the line or lines for the languages you want to activate or deactivate Copilot for. For example, to deactivate Copilot for all languages:

   XML

   <entry key="*" value="false" />
   

3. Save the changes to the -copilot.xml file.

4. Restart your JetBrains IDE for the changes to take effect.

Example language configurations

The default configuration of the -copilot.xml file, which enables Copilot for all languages is as follows:

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

To deactivate Copilot for all languages, the wildcard (*) value is changed to false:

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

To specify languages individually, add an entry for each language you want to activate or deactivate Copilot for. Specific language settings will override the wildcard. For example, to activate Copilot for Python and YAML, and deactivate Copilot for all other languages, add the following entries:

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

You can also add a configuration to make the languageAllowList readonly in the IDE's settings. This will prevent you from changing the language settings in the IDE. For example:

<application>
  <component name="-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

Configuring Copilot settings on .com

If you are using a Copilot Pro plan, you can choose to allow or block code completion suggestions that match publicly available code. You configure this in your personal settings on .com. See Managing Copilot policies as an individual subscriber.

Authenticating to an account on GHE.com

If you're using a Copilot plan for a managed user account on GHE.com, you'll need to update some settings before you sign in. See Using Copilot with an account on GHE.com.

Further reading

• Copilot FAQ