Repository files navigation

GitHub Copilot is an AI pair programmertool that helps you write code faster and smarter. Copilot for Xcode is an Xcodeextension that provides inline coding suggestions as you type.

Use of the GitHub Copilot Xcode Extension is subject toGitHub's Pre-Release Terms. We want to remind you that:

Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better.

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

1. Install viaHomebrew:

   brew install --cask github-copilot-for-xcode

   Or download thedmg fromthe latest release.DragGitHub Copilot for Xcode into theApplications folder:

   

   Updates can be downloaded and installed by the app.

2. A background item will be added to enable Copilot to start when Xcode is opened.

   

3. Two permissions are required:Accessibility andXcode Source Editor Extension. For more on why these permissions are required seeTROUBLESHOOTING.md.

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

   

   TheXcode Source Editor Extension permission needs to be enabled manually. ClickExtension Permission from theCopilot for Xcode settings to open theSystem Preferences to theExtensions panel. SelectXcode Source Editorand enableGitHub Copilot:

   

4. After granting the extension permission, please restart Xcode to ensure theGithub Copilot menu is available and not disabled under the XcodeEditormenu.
   

   

   Keyboard shortcuts can be set for all menu items in theKey Bindingssection of Xcode preferences.

5. To sign into GitHub Copilot, click theSign 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.

   

6. To install updates, clickCheck for Updates from the menu item or in thesettings application.

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

   New versions can also be installed fromdmg files downloaded from thereleases page. When installing a new version viadmg, the application mustbe run manually the first time to accept the downloaded from the internetwarning.

7. To avoid confusion, we recommend disablingPredictive code completion underXcode >Preferences >Text Editing >Editing.

8. Presstab to accept the first line of a suggestion, holdoption to viewthe full suggestion, and pressoption +tab to accept the full suggestion.

   

This project is licensed under the terms of the MIT open source license. Pleaserefer toLICENSE.txt for the full terms.

We follow responsible practices in accordance with ourPrivacy Statement.

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

We’d love to get your help in making GitHub Copilot better! If you havefeedback or encounter any problems, please reach out on ourFeedbackforum.

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 inCredits.rtf.