Skip to main content

Troubleshooting GitHub Copilot in your environment

Troubleshoot GitHub Copilot related errors in your IDE.

GitHub Copilot can be managed through personal accounts with GitHub Copilot for Individuals or through organization accounts with GitHub Copilot for Business.

GitHub Copilot is free to use for verified students, teachers, and maintainers of popular open source projects. If you are not a student, teacher, or maintainer of a popular open source project, you can try GitHub Copilot for free with a one-time 30-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "About billing for GitHub Copilot."

About troubleshooting GitHub Copilot in your JetBrains IDE

To troubleshoot issues with GitHub Copilot or your JetBrains IDE, you can view the log files. The location of the log files depends on the JetBrains IDE you are using. For more information, see "Configuring GitHub Copilot in your environment."

Collecting log files

These steps describe how to view and collect the log files for the following JetBrains IDEs:

  • IntelliJ IDEA
  • Android Studio
  • GoLand
  • PhpStorm
  • PyCharm
  • RubyMine
  • WebStorm

The GitHub Copilot extension logs to the IDEA log location for IntelliJ plugins.

  1. In your JetBrains IDE, open the Help menu.
  2. Go to Show Log in Finder.
  3. Open the idea.log in your preferred editor and look for any errors related to GitHub or GitHub Copilot.

For more information, see the Locating IDE log files in the IntelliJ documentation.

Collect log files from Rider

  1. In Rider, open the Help menu.
  2. Go to Diagnostic Tools.
  3. Go to Show Log in.
  4. Open the idea.log in your preferred editor and look for any errors related to GitHub or GitHub Copilot.

Viewing logs in Visual Studio

The log files for the GitHub Copilot extension are stored in the standard log location for Visual Studio extensions.

  1. Open the the View menu in Visual Studio.
  2. Click Output.
  3. On the right of the Output view pane, select GitHub Copilot from the dropdown menu.

Further reading

Viewing and collecting log files

The log files for the GitHub Copilot extension are stored in the standard log location for Visual Studio Code extensions. The log files are useful for diagnosing connection issues.

  1. Open the View menu in Visual Studio Code.
  2. Click Output.
  3. On the right of the Output view pane, select GitHub Copilot from the dropdown menu.

Alternatively, you can open the log folder for Visual Studio Code extensions in your system's file explorer. This is useful if you need to forward the log files to the support team.

  1. Open the VS Code Command Palette
    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use: Ctrl+Shift+P
  2. Type "Logs", and then select Developer: Open Extension Logs Folder from the list.

Viewing network connectivity diagnostics logs

If you encounter problems connecting to GitHub Copilot due to network restrictions, firewalls, or your proxy setup, use the following troubleshooting steps.

  1. Open the VS Code Command Palette
    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use: Ctrl+Shift+P
  2. Type "Diagnostics", and then select GitHub Copilot: Collect Diagnostics from the list. This opens a new editor with the relevant information that you can inspect yourself or share with the support team.
  3. Check the section on Reachability to determine if GitHub Copilot can actually access the necessary services.

Viewing Electron logs

In rare cases, errors might not be propagated to the corresponding error handlers and are not logged in the regular locations. If you encounter errors and there is nothing in the logs, you may try to see the logs from the process running VS Code and the extension.

  1. Open the VS Code Command Palette

    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use Ctrl+Shift+P
  2. Type "Toggle", and then select Developer: Toggle Developer Tools from the list.

  3. In the Developer Tools window, select the Console tab to see any errors or warnings.

    Screenshot of the Developer Tools window in Visual Studio Code. The console tab is outlined in dark orange.

Further reading

Checking if GitHub Copilot is operational

To check if GitHub Copilot is operational, run the following command in Neovim:

:Copilot status