Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions content/copilot/how-tos/copilot-cli/cli-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,23 @@ Use one of these commands:

* **Cross-platform (npm)**

```bash copy
npm install -g @github/copilot
```
Prerequisite: {% data variables.copilot.copilot_cli_npm_version %}.

```bash copy
npm install -g @github/copilot
```

* **Windows (WinGet)**

```bash copy
winget install GitHub.Copilot
```
```bash copy
winget install GitHub.Copilot
```

* **macOS/Linux (Homebrew)**

```bash copy
brew install copilot-cli
```
```bash copy
brew install copilot-cli
```

## Starting the CLI for the first time

Expand Down
33 changes: 21 additions & 12 deletions content/copilot/how-tos/copilot-cli/install-copilot-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,27 @@ If you have access to {% data variables.product.prodname_copilot %} via your org

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 npm (all platforms)

Prerequisite: {% data variables.copilot.copilot_cli_npm_version %}.

```shell copy
npm install -g @github/copilot
```

> [!NOTE]
> If you have `ignore-scripts=true` in your `~/.npmrc` file, you must use the command:
>
> ```shell copy
> npm_config_ignore_scripts=false npm install -g @github/copilot
> ```

To install the prerelease version:

```shell copy
npm install -g @github/copilot@prerelease
```

### Installing with WinGet (Windows)

```powershell copy
Expand All @@ -60,18 +81,6 @@ To install the prerelease version:
brew install copilot-cli@prerelease
```

### Installing with npm (all platforms, requires Node.js 22+)

```shell copy
npm install -g @github/copilot
```

To install the prerelease version:

```shell copy
npm install -g @github/copilot@prerelease
```

### Installing with the install script (macOS and Linux)

```shell copy
Expand Down
1 change: 1 addition & 0 deletions data/variables/copilot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ copilot_cli_short: 'Copilot CLI'
copilot_cli: 'GitHub Copilot CLI'
copilot_old-cli_short: 'Copilot in the CLI'
copilot_old-cli: 'GitHub Copilot in the CLI'
copilot_cli_npm_version: 'Node.js 22 or later'

## Copilot custom agents
copilot_custom_agent: 'Copilot custom agent'
Expand Down