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
Copy file name to clipboardExpand all lines: README.md
+2-4
Original file line number
Diff line number
Diff line change
@@ -43,14 +43,12 @@ You can receive auto-complete type suggestions from GitHub Copilot either by sta
43
43
</p>
44
44
45
45
46
-
1. A background item will be added to enable Copilot to start when `GitHub Copilot for Xcode`is opened.
46
+
1. A background item will be added to enable the GitHub Copilot for Xcode extension app to connect to the host app. This permission is usually automatically added when first launching the app.
47
47
<palign="center">
48
48
<imgalt="Screenshot of background item"src="./Docs/background-item.png"width="370" />
49
49
</p>
50
50
51
-
1. Two permissions are required: `Accessibility` and `Xcode Source Editor
52
-
Extension`. For more on why these permissions are required see
53
-
[TROUBLESHOOTING.md](./TROUBLESHOOTING.md).
51
+
1. Three permissions are required for GitHub Copilot for Xcode to function properly: `Background`, `Accessibility`, and `Xcode Source Editor Extension`. For more details on why these permissions are required see [TROUBLESHOOTING.md](./TROUBLESHOOTING.md).
54
52
55
53
The first time the application is run the `Accessibility` permission should be requested:
enabled by the Xcode Source Editor extension permission only provides
42
43
information when manually triggered by the user. In order to generate
43
-
suggestions as you type, the accessibility permission is used read the
44
+
suggestions as you type, the accessibility permission is used to read the
44
45
Xcode editor content in real-time.
45
46
46
47
The accessibility permission is also used to accept suggestions when `tab` is
@@ -53,6 +54,32 @@ but you can audit the usage in this repository: search for `CGEvent` and `AX`*.
53
54
Enable in System Settings under `Privacy & Security` > `Accessibility` >
54
55
`GitHub Copilot for Xcode Extension` and turn on the toggle.
55
56
57
+
## Background Permission
58
+
59
+
GitHub Copilot for Xcode requires background permission to connect with the host app. This permission ensures proper communication between the components of GitHub Copilot for Xcode, which is essential for its functionality in Xcode.
This permission is typically granted automatically when you first launch GitHub Copilot for Xcode. However, if you encounter connection issues, alerts, or errors as follows:
67
+
68
+
<palign="center">
69
+
<img alt="Alert of Background Permission Required" src="./Docs/background-permission-required.png" width="350" />
70
+
<img alt="Error connecting to the communication bridge" src="./Docs/connect-comm-bridge-failed.png" width="550" />
71
+
</p>
72
+
73
+
Please ensure that this permission is enabled. You can manually navigate to the background permission setting based on your macOS version:
74
+
75
+
| macOS | Location |
76
+
| :--- | :--- |
77
+
| 15 | System Settings > General > Login Items & Extensions > Allow in the Background |
78
+
| 13 & 14 | System Settings > General > Login Items > Allow in the Background |
79
+
80
+
Ensure that "GitHub Copilot for Xcode" is enabled in the list of allowed background items. Without this permission, the extension may not be able to properly communicate with the host app, which can result in inconsistent behavior or reduced functionality.
81
+
82
+
56
83
## Logs
57
84
58
85
Logs can be found in `~/Library/Logs/GitHubCopilot/` the most recent log file
0 commit comments