Use GitHub Copilot

The Copilot plugin (disabled by default) integrates GitHub Copilot into Qt Creator. You can view suggestions from Copilot in the Edit mode.

Requirements

To use the Copilot plugin, you need:

• An active GitHub Copilot subscription.
• GitHub Copilot Neovim plugin installed (requires Node.js), as described in Copilot.vim/Readme.md.

Set Copilot preferences

To set preferences for using Copilot:

1. Go to Preferences > Copilot.

   

2. Select Enable Copilot to use Copilot.
3. Select Sign In to sign into your subscription, activate your device, and authorize the GitHub Copilot plugin.

   The button turns into a Sign Out button.

4. In Node.js path, enter the full path to the Node.js executable.
5. In Path to agent.js, enter the path to agent.js in the Copilot Neovim plugin installation folder.
6. Select Auto request to receive suggestions for the current text cursor position when you make changes.
7. Select Use proxy to use a proxy server to connect to Copilot servers.
8. In Proxy host, enter the host name of the proxy server.
9. In Proxy port, enter the port number of the proxy server.
10. Select Reject unauthorized to prevent the security risk presented by accepting unauthorized certificates from the proxy server.
11. In Proxy user, enter the user name to authenticate to the proxy server.
12. Select Save proxy password to save the password to authenticate to the proxy server.

    Note: The password is saved insecurely.

13. In Proxy password, enter the password to save. To see the password as you type, select .

Receive suggestions

When you write code in the Edit mode and Auto request is enabled, Copilot automatically makes suggestions when you type.

To manually request a suggestion at the current editor's cursor position, enter t (Request Copilot Suggestion) in the locator.

Hover the mouse over a suggestion to show a toolbar with and buttons for cycling between Copilot suggestions.

To apply a suggestion as a whole, select Apply or press the Tab key.

To apply a suggestion word-by-word, select Apply Word or press Alt+Right.

To reject a suggestion, press Esc or the arrow keys.

Turn suggestions on and off

You can turn the Copilot suggestions on and off either globally for all projects or at project level for a particular project.

Toggle Copilot suggestions

To turn Copilot suggestions on or off globally, select (Toggle Copilot). This also sets the value of Enable Copilot in Preferences > Copilot accordingly.

Turn suggestions on or off for a project

To turn Copilot suggestions on or off for a particular project:

1. Go to Projects > Project Settings > Copilot.

   

2. Clear Use global settings.
3. Select or clear Enable Copilot.