Skip to content

Commit de80b57

Browse files
committed
Update README.md
1 parent cc577c3 commit de80b57

1 file changed

Lines changed: 25 additions & 13 deletions

File tree

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,31 @@ Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing t
2222

2323
### Install
2424

25-
1. Download the Copilot for Xcode.app from the latest [release](https://github.com/intitni/CopilotForXcode/releases), and extract it to the Applications folder.
25+
1. Download the `Copilot for Xcode.app` from the latest [release](https://github.com/intitni/CopilotForXcode/releases), and extract it to the Applications folder.
2626
2. Open the app, and click "Set Up Launch Agents" to set up a background running XPC Service that does the real job.
27-
3. Enable the extension in the Settings.app, then maybe restart Xcode.
27+
3. Enable the extension in `System Settings.app`.
2828

29-
### Sign In Github Copilot
29+
From the Apple menu located in the top-left corner of your screen click `System Settings`. Navigate to `Privacy & Security` then toward the bottom click `Extensions`. Click `Xcode Source Editor` and tick `Copilot`.
30+
31+
If you are using macOS Monterey, enter the `Extensions` menu in `System Preferences.app` with its dedicated icon.
32+
33+
### Sign In GitHub Copilot
3034

31-
1. In the app, refresh the Copilot status, if it fails, quit and restart the app.
32-
2. Click "Sign In", you will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
35+
1. In the app, refresh the Copilot status (it may fail for the first time, try at least one more time).
36+
2. Click "Sign In", and you will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
3337
3. After signing in, go back to the app and click "Confirm Sign-in" to finish.
3438

35-
The first time the commands run, the extension will ask for 2 types of permissions:
36-
1. Accessibility API: which the extension uses to get the editing file path.
37-
2. Folder Access: the extension needs, to run some Apple Scripts to get the project/workspace path.
39+
### Giving Permissions to the App
40+
41+
The first time the commands run, the extension will ask for the permissions needed.
42+
43+
Or you can add them manually by going to the `Privacy & Security` tab in `System Settings.app`, and
44+
- Accessibility API: Click `Accessibility`, and add `Copilot for Xcode.app` to the list.
45+
- Input Monitoring: Click `Input Monitoring` and add `Copilot for Xcode.app` to the list.
3846

3947
## Update
4048

41-
You can manually download the latest release. After updating the app, don't forget to click `Restart XPC Service` in the app to kill the old version and run the new version.
49+
You can manually download the latest release. After updating the app, don't forget to click `Restart XPC Service` in the app to kill the old version and run the new version. (I will make it auto-restartable later. )
4250

4351
If you want to keep track of the new releases, you can watch this repo's releases to get notifications on updates.
4452

@@ -87,21 +95,25 @@ fi
8795

8896
**Q: The extension doesn't show up in the `Editor` menu.**
8997

90-
> A: Please make sure it's turned on in `Settings.app > Privacy & Security > Extensions > Xcode Source Editor Extension`.
98+
> A: Please make sure `Copilot for Xcode` is turned on in `System Settings.app > Privacy & Security > Extensions > Xcode Source Editor Extension`.
9199
92100
**Q: The extension says it can't connect to the XPC service/helper.**
93101

94-
> A: Please make sure you have set up Launch Agents, try running `launchctl list | grep com.intii` from the terminal, and see if `com.intii.CopilotForXcode.XPCService` exists. If not, check `~/Library/LaunchAgents` to see if `com.intii.CopilotForXcode.XPCService.plist` exists. If they don't, and the button in the app fails to create them, please try to do it by hand.
102+
> A: If you have just updated the app from an old version, make sure you have restarted the XPC Service.
103+
>
104+
> Please make sure you have set up Launch Agents, try running `launchctl list | grep com.intii` from the terminal, and see if `com.intii.CopilotForXcode.XPCService` exists. If not, check `~/Library/LaunchAgents` to see if `com.intii.CopilotForXcode.XPCService.plist` exists. If they don't, and the button in the app fails to create them, please try to do it by hand.
105+
>
106+
> If you are installing multiple versions of the extension on your machine, it's also possible that Xcode is using the older version of the extension.
95107
96108
**Q: The extension complains that it has no access to the Accessibility API**
97109

98-
> A: Check the list in `Settings.app > Privacy & Security > Accessibility`. Turn the toggle on for `Copilot for Xcode`. If it's not on the list, add it manually.
110+
> A: Check the list in `System Settings.app > Privacy & Security > Accessibility`. Turn the toggle on for `Copilot for Xcode`. If it's not on the list, add it manually.
99111
>
100112
> If you have just **updated the app**, consider restarting XPCService in app or trying removing the Launch Agents and set it up again!
101113
102114
**Q: I turned on real-time suggestions, but nothing happens**
103115

104-
> A: Check the list in `Settings.app > Privacy & Security > Input Monitoring`. Turn the toggle on for `Copilot for Xcode`. If it's not on the list, add it manually. After that, you may have to restart the XPC Service.
116+
> A: Check the list in `System Settings.app > Privacy & Security > Input Monitoring`. Turn the toggle on for `Copilot for Xcode`. If it's not on the list, add it manually. After that, you may have to restart the XPC Service.
105117
>
106118
> If that doesn't help, try to restart the XPC Service again.
107119

0 commit comments

Comments
 (0)