GitHub Copilot for Xcode

GitHub Copilot is an AI pair programmer tool that helps you write code faster and smarter. Copilot for Xcode is an Xcode extension that provides inline coding suggestions as you type and a chat assistant to answer your coding questions.

Chat

GitHub Copilot Chat provides suggestions to your specific coding tasks via chat.

Code Completion

You can receive auto-complete type suggestions from GitHub Copilot either by starting to write the code you want to use, or by writing a natural language comment describing what you want the code to do.

Requirements

macOS 12+
Xcode 8+
A GitHub Copilot subscription. To learn more, visit https://github.com/features/copilot.

Getting Started

Install via Homebrew:
```
brew install --cask github-copilot-for-xcode
```
Or download the dmg from the latest release. Drag GitHub Copilot for Xcode into the Applications folder:

Updates can be downloaded and installed by the app.
Open the GitHub Copilot for Xcode application (from the Applications folder). Accept the security warning.
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.
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.

The first time the application is run the Accessibility permission should be requested:

The Xcode Source Editor Extension permission needs to be enabled manually. Click Extension Permission from the GitHub Copilot for Xcode application settings to open the System Preferences to the Extensions panel. Select Xcode Source Editor and enable GitHub Copilot:
After granting the extension permission, open Xcode. Verify that the Github Copilot menu is available and enabled under the Xcode Editor menu.

Keyboard shortcuts can be set for all menu items in the Key Bindings section of Xcode preferences.
To sign into GitHub Copilot, click the Sign in button in the settings application. This will open a browser window and copy a code to the clipboard. Paste the code into the GitHub login page and authorize the application.
To install updates, click Check for Updates from the menu item or in the settings application.

After installing a new version, Xcode must be restarted to use the new version correctly.

New versions can also be installed from dmg files downloaded from the releases page. When installing a new version via dmg, the application must be run manually the first time to accept the downloaded from the internet warning.
To avoid confusion, we recommend disabling Predictive code completion under Xcode > Preferences > Text Editing > Editing.
Press tab to accept the first line of a suggestion, hold option to view the full suggestion, and press option + tab to accept the full suggestion.

How to use Chat

Open Copilot Chat in GitHub Copilot.

Open via the Xcode menu Xcode -> Editor -> GitHub Copilot -> Open Chat.

Open via GitHub Copilot app menu Open Chat.

How to use Code Completion

Press tab to accept the first line of a suggestion, hold option to view the full suggestion, and press option + tab to accept the full suggestion.

License

This project is licensed under the terms of the MIT open source license. Please refer to LICENSE.txt for the full terms.

Privacy

We follow responsible practices in accordance with our Privacy Statement.

To get the latest security fixes, please use the latest version of the GitHub Copilot for Xcode.

Support

We’d love to get your help in making GitHub Copilot better! If you have feedback or encounter any problems, please reach out on our Feedback forum.

Acknowledgements

Thank you to @intitni for creating the original project that this is based on.

Attributions can be found under About when running the app or in Credits.rtf.

License

CraeSoul/CopilotForXcode

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages