Skip to content

Commit 732e438

Browse files
committed
Update README.md
1 parent 25a2426 commit 732e438

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
![Screenshot](/Screenshot.png)
44

5-
Copilot for Xcode is an Xcode Source Editor Extension that provides GitHub Copilot and ChatGPT support for Xcode.
5+
Copilot for Xcode is an Xcode Source Editor Extension that provides GitHub Copilot, Codeium and ChatGPT support for Xcode.
66

77
<a href="https://www.buymeacoffee.com/intitni" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
88

99
## Features
1010

11-
- Code Suggestions (powered by GitHub Copilot).
11+
- Code Suggestions (powered by GitHub Copilot and Codeium).
1212
- Chat (powered by OpenAI ChatGPT).
1313
- Prompt to Code (powered by OpenAI ChatGPT).
1414
- Custom Commands to extend Chat and Prompt to Code.
@@ -20,7 +20,8 @@ Copilot for Xcode is an Xcode Source Editor Extension that provides GitHub Copil
2020
- [Installation and Setup](#installation-and-setup)
2121
- [Install](#install)
2222
- [Enable the Extension](#enable-the-extension)
23-
- [Sign In GitHub Copilot](#sign-in-github-copilot)
23+
- [Setting Up GitHub Copilot](#setting-up-github-copilot)
24+
- [Setting Up Codeium](#setting-up-codeium)
2425
- [Setting Up OpenAI API Key](#setting-up-openai-api-key)
2526
- [Granting Permissions to the App](#granting-permissions-to-the-app)
2627
- [Managing `CopilotForXcodeExtensionService.app`](#managing-copilotforxcodeextensionserviceapp)
@@ -40,8 +41,11 @@ For development instruction, check [Development.md](DEVELOPMENT.md).
4041
- Public network connection.
4142

4243
For suggestion features:
43-
- [Node](https://nodejs.org/) installed to run the Copilot LSP.
44-
- Active GitHub Copilot subscription.
44+
- For GitHub Copilot users:
45+
- [Node](https://nodejs.org/) installed to run the Copilot LSP.
46+
- Active GitHub Copilot subscription.
47+
- For Codeium users:
48+
- Active Codeium account.
4549

4650
For chat and prompt to code features:
4751
- Valid OpenAI API key.
@@ -65,10 +69,7 @@ brew install --cask copilot-for-xcode
6569

6670
Or install it manually, by downloading the `Copilot for Xcode.app` from the latest [release](https://github.com/intitni/CopilotForXcode/releases), and extract it to the Applications folder.
6771

68-
Then set it up with the following steps:
69-
70-
1. Open the app, the app will create a launch agent to setup a background running Service that does the real job.
71-
2. Optionally setup the path to Node. The default value is just `node`, Copilot for Xcode.app will try to find the Node from the PATH available in a login shell. If your Node is installed somewhere else, you can run `which node` from terminal to get the path.
72+
Open the app, the app will create a launch agent to setup a background running Service that does the real job.
7273

7374
### Enable the Extension
7475

@@ -78,11 +79,26 @@ From the Apple menu located in the top-left corner of your screen click `System
7879

7980
If you are using macOS Monterey, enter the `Extensions` menu in `System Preferences.app` with its dedicated icon.
8081

81-
### Sign In GitHub Copilot
82+
### Setting Up GitHub Copilot
8283

83-
1. In the host app, click GitHub Copilot to enter the GitHub Copilot account settings.
84-
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.
85-
3. After signing in, go back to the app and click "Confirm Sign-in" to finish.
84+
1. In the host app, switch to the service tab and click GitHub Copilot to enter the GitHub Copilot account settings.
85+
2. Optionally setup the path to Node. The default value is just `node`, Copilot for Xcode.app will try to find the Node from the PATH available in a login shell. If your Node is installed somewhere else, you can run `which node` from terminal to get the path.
86+
3. 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.
87+
4. After signing in, go back to the app and click "Confirm Sign-in" to finish.
88+
5. Go to "Feature - Suggestion" and update the feature provider to "GitHub Copilot".
89+
90+
The installed language server is located at `~/Library/Application Support/com.intii.CopilotForXcode/GitHub Copilot/executable/`.
91+
92+
### Setting Up Codeium
93+
94+
1. In the host app, switch to the service tab and click Codeium to enter the Codeium account settings.
95+
2. Click "Install" to install the language server.
96+
3. Click "Sign In", and you will be directed to codeium.com. After signing in, a token will be presented. You will need to paste the token back to the app to finish signing in.
97+
4. Go to "Feature - Suggestion" and update the feature provider to "Codeium".
98+
99+
> The key is stored in keychain. When the helper app tries to access the key for the first time, it will prompt you to enter the password access the keychain for the key. Please select "Always Allow" to let the helper app access the key.
100+
101+
The installed language server is located at `~/Library/Application Support/com.intii.CopilotForXcode/Codeium/executable/`.
86102

87103
### Setting Up OpenAI API Key
88104

@@ -125,7 +141,7 @@ If you find that some of the features are no longer working, please first try re
125141

126142
### Suggestion
127143

128-
GitHub Copilot can provide real-time code suggestions based on the files you have opened. It utilizes its knowledge of your codebase to generate helpful suggestions.
144+
The app can provide real-time code suggestions based on the files you have opened. It's powered by GitHub Copilot and Codeium.
129145

130146
If you're working on a company project and don't want the suggestion feature to be triggered, you can globally disable it and choose to enable it only for specific projects.
131147

@@ -156,7 +172,7 @@ Whenever you stop typing for a few milliseconds, the app will automatically fetc
156172

157173
This feature is powered by ChatGPT. Please ensure that you have set up your OpenAI account before using it.
158174

159-
There are currently two tabs in the chat panel: one is available globally across Xcode, and the other is only available in the current file.
175+
There are currently two tabs in the chat panel: one is available shared across Xcode, and the other is only available in the current file.
160176

161177
You can detach the chat panel by simply dragging it away. Once detached, the chat panel will remain visible even if Xcode is inactive. To re-attach it to the widget, click the message bubble button located next to the circular widget.
162178

@@ -246,7 +262,7 @@ fi
246262

247263
MIT.
248264

249-
## What's More
265+
## Credits
250266

251267
The app uses the LSP provided through [Copilot.vim](https://github.com/github/copilot.vim/tree/release/copilot/dist) to generate suggestions and displays them as comments or in a separate window.
252268

0 commit comments

Comments
 (0)