Troubleshooting for Copilot for Xcode

Troubleshooting for Copilot for Xcode

If you are having trouble with Copilot for Xcode follow these steps to resolve common issues:

1. Check for updates and restart Xcode. Ensure that Copilot for Xcode has the [latest release](https://github.com/github/CopilotForXcode/releases/latest) by clicking `Check for Updates` in the settings or under the status menu. After updating, restart Xcode.

2. Ensure that all required permissions are granted. GitHub Copilot for Xcode app requires these permissions to function properly:

   • Extension Permission - Allows GitHub Copilot to integrate with Xcode
   • Accessibility Permission - Enables real-time code suggestions
   • Background Permission - Allows extension to connect with host app
   • Files & Folders Permission - Allows GitHub Copilot for Xcode to access files and folders
   • Screen & System Audio Recording Permission (Optional) - Allow GitHub Copilot for Xcode to capture screen when using Copilot Vision

   Please note that GitHub Copilot for Xcode may not work properly if any necessary permissions are missing.

3. Need more help? If these steps don't resolve the issue, please [open an issue](https://github.com/github/CopilotForXcode/issues/new/choose). Make sure to [include logs](#logs) and any other relevant information.

Extension Permission

GitHub Copilot for Xcode is an Xcode Source Editor extension and requires the extension to be enabled. In the Copilot for Xcode settings, clicking `Extension Permission` will open the System Settings to the Extensions page where `GitHub Copilot` can be enabled under `Xcode Source Editor`.

Or you can navigate to the permission manually depending on your OS version:

macOS	Location
26	System Settings > General > Login Items & Extensions > Extensions > By Category > Xcode Source Editor
15	System Settings > General > Login Items & Extensions > Extensions > Xcode Source Editor
13 & 14	System Settings > Privacy & Security > Extensions > Xcode Source Editor
12	System Preferences > Extensions

Accessibility Permission

GitHub Copilot for Xcode requires the accessibility permission to receive real-time updates from the active Xcode editor. [The XcodeKit API](https://developer.apple.com/documentation/xcodekit) enabled by the Xcode Source Editor extension permission only provides information when manually triggered by the user. In order to generate suggestions as you type, the accessibility permission is used to read the Xcode editor content in real-time.

The accessibility permission is also used to accept suggestions when `tab` is pressed.

The accessibility permission is __not__ used to read or write to any applications besides Xcode. There are no granular options for the permission, but you can audit the usage in this repository: s