Skip to content

INSTALLATION.md

Latest commit

 

History

History
50 lines (33 loc) · 1.88 KB

INSTALLATION.md

File metadata and controls

50 lines (33 loc) · 1.88 KB
Raw

Installation

Use this guide when you need a clean installation of GitHub Copilot for Xcode on a Mac.

Prerequisites

  • macOS 12 or later
  • A version of Xcode that supports Source Editor Extensions
  • A GitHub account with GitHub Copilot access, or BYOK provider credentials if you plan to use external models

Install with Homebrew

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

Install from a DMG

  1. Download the latest DMG from the latest release.
  2. Drag GitHub Copilot for Xcode into /Applications.
  3. Launch the app once so macOS can register the helper processes and extension.

First Launch Checklist

  1. Open GitHub Copilot for Xcode from /Applications.
  2. Accept the macOS security prompt for the downloaded app.
  3. Allow the background item used to connect the host app and the Xcode extension.
  4. Turn on Accessibility access when prompted.
  5. Open Extension Permission from the app settings and enable GitHub Copilot under Xcode Source Editor.
  6. Start Xcode and verify that Editor > GitHub Copilot is available.

Sign In

  1. In the app, click Sign in.
  2. Complete the browser-based device flow with the GitHub account that owns your Copilot entitlement.
  3. Return to the app after authorization finishes.

Optional: Bring Your Own Key (BYOK)

If you want to use your own model provider credentials, continue with the configuration guide and the existing BYOK reference.

Updating

  • Use Check for Updates from the app or status menu.
  • Restart Xcode after installing an update.
  • If you reinstall from a DMG, relaunch the app once before reopening Xcode.

Troubleshooting

If setup fails, use the repository's troubleshooting guide for permission, login item, and extension issues.