4.7 KiB
title, shortTitle, intro, versions, topics, redirect_from, contentType, category
| title | shortTitle | intro | versions | topics | redirect_from | contentType | category | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Installing GitHub Copilot CLI | Install Copilot CLI | Learn how to install {% data variables.copilot.copilot_cli_short %} so that you can use {% data variables.product.prodname_copilot_short %} directly from the command line. |
|
|
|
how-tos |
|
{% data reusables.cli.preview-note-cli %}
To find out about {% data variables.copilot.copilot_cli_short %} before you install it, see AUTOTITLE.
Prerequisites
- An active {% data variables.product.prodname_copilot %} subscription. See {% data variables.product.prodname_copilot_short %} plans.
- (On Windows) PowerShell v6 or higher
If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.copilot.copilot_cli_short %} if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See AUTOTITLE.
Installing or updating {% data variables.copilot.copilot_cli_short %}
You can install {% data variables.copilot.copilot_cli_short %} using WinGet (Windows), Homebrew (macOS and Linux), npm (all platforms), or an install script (macOS and Linux).
Installing with WinGet (Windows)
winget install GitHub.Copilot
To install the prerelease version:
winget install GitHub.Copilot.Prerelease
Installing with Homebrew (macOS and Linux)
brew install copilot-cli
To install the prerelease version:
brew install copilot-cli@prerelease
Installing with npm (all platforms, requires Node.js 22+)
npm install -g @github/copilot
To install the prerelease version:
npm install -g @github/copilot@prerelease
Installing with the install script (macOS and Linux)
curl -fsSL https://gh.io/copilot-install | bash
Or:
wget -qO- https://gh.io/copilot-install | bash
To run as root and install to /usr/local/bin, use | sudo bash.
To install to a custom directory, set the PREFIX environment variable. It defaults to /usr/local when run as root or $HOME/.local when run as a non-root user.
To install a specific version, set the VERSION environment variable. It defaults to the latest version.
For example, to install version v0.0.369 to a custom directory:
curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash
Download from {% data variables.product.prodname_dotcom_the_website %}
You can download the executables directly from the copilot-cli repository.
Download the executable for your platform, unpack it, and run.
Authenticating with {% data variables.copilot.copilot_cli_short %}
On first launch, if you're not currently logged in to {% data variables.product.github %}, you'll be prompted to use the /login slash command. Enter this command and follow the on-screen instructions to authenticate.
Authenticating with a {% data variables.product.pat_generic %}
You can also authenticate using a {% data variables.product.pat_v2 %} with the "{% data variables.product.prodname_copilot_short %} Requests" permission enabled.
- Visit {% data variables.product.pat_v2_caps_plural %}.
- Under "Permissions," click Add permissions and select {% data variables.product.prodname_copilot_short %} Requests.
- Click Generate token.
- Add the token to your environment using the
GH_TOKENorGITHUB_TOKENenvironment variable (in order of precedence).
Next steps
You can now use {% data variables.product.prodname_copilot_short %} from the command line. See AUTOTITLE.