Skip to content

Commit 2d8fb29

Browse files
committed
Update README.md
1 parent 1657e33 commit 2d8fb29

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing t
1414
- [Permissions Required](#permissions-required)
1515
- [Installation and Setup](#installation-and-setup)
1616
- [Install](#install)
17+
- [Enable the Extension](#enable-the-extension)
1718
- [Sign In GitHub Copilot](#sign-in-github-copilot)
19+
- [Setting Up OpenAI API Key](#setting-up-openai-api-key)
1820
- [Granting Permissions to the App](#granting-permissions-to-the-app)
1921
- [Managing `CopilotForXcodeExtensionService.app`](#managing-copilotforxcodeextensionserviceapp)
2022
- [Update](#update)
@@ -58,18 +60,26 @@ Then set it up with the following steps:
5860

5961
1. Open the app, the app will create a launch agent to setup a background running Service that does the real job.
6062
2. Optionally setup the path to Node. The default value is just `node`, Copilot for Xcode.app will try to find the Node from `/usr/bin:/usr/local/bin`. If your Node is installed somewhere else, you can run `which node` from terminal to get the path.
61-
3. Enable the extension in `System Settings.app`.
6263

63-
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`.
64+
### Enable the Extension
65+
66+
Enable the extension in `System Settings.app`.
67+
68+
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`.
6469

65-
If you are using macOS Monterey, enter the `Extensions` menu in `System Preferences.app` with its dedicated icon.
70+
If you are using macOS Monterey, enter the `Extensions` menu in `System Preferences.app` with its dedicated icon.
6671

6772
### Sign In GitHub Copilot
6873

69-
1. In the app, refresh the Copilot status (it may fail for the first time, try at least one more time).
74+
1. In the host app, click GitHub Copilot to enter the GitHub Copilot account settings.
7075
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.
7176
3. After signing in, go back to the app and click "Confirm Sign-in" to finish.
7277

78+
### Setting Up OpenAI API Key
79+
80+
1. In the host app, click OpenAI to enter the OpenAI account settings.
81+
2. Enter your api key to the text field.
82+
7383
### Granting Permissions to the App
7484

7585
The first time the app is open and command run, the extension will ask for the necessary permissions.
@@ -100,8 +110,6 @@ Alternatively, You can use the in-app updater or download the latest version man
100110

101111
If you are upgrading from a version lower than **0.7.0**, please run `Copilot for Xcode.app` at least once to let it set up the new launch agent for you and re-grant the permissions according to the new rules.
102112

103-
If you want to keep track of the new releases, you can watch the releases of this repo to get notifications about updates.
104-
105113
If you find that some of the features are no longer working, please first try regranting permissions to the app.
106114

107115
## Commands

0 commit comments

Comments
 (0)