Skip to content
Merged
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
55 changes: 29 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitHub Copilot CLI (Public Preview)
# GitHub Copilot CLI

The power of GitHub Copilot, now in your terminal.

Expand Down Expand Up @@ -38,61 +38,64 @@ If you have access to GitHub Copilot via your organization or enterprise, you ca

### Installation

Install with [WinGet](https://github.com/microsoft/winget-cli) (Windows):
Install with the install script (macOS and Linux):

```bash
winget install GitHub.Copilot
curl -fsSL https://gh.io/copilot-install | bash
```

Or

```bash
winget install GitHub.Copilot.Prerelease
wget -qO- https://gh.io/copilot-install | bash
```

Install with [Homebrew](https://formulae.brew.sh/cask/copilot-cli) (macOS and Linux):
Use `| sudo bash` to run as root and install to `/usr/local/bin`.

```bash
brew install copilot-cli
```
Set `PREFIX` to install to `$PREFIX/bin/` directory. Defaults to `/usr/local`
when run as root or `$HOME/.local` when run as a non-root user.

Set `VERSION` to install a specific version. Defaults to the latest version.

For example, to install version `v0.0.369` to a custom directory:

```bash
brew install copilot-cli@prerelease
curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash
```

Install with [npm](https://www.npmjs.com/package/@github/copilot) (macOS, Linux, and Windows):
Install with [Homebrew](https://formulae.brew.sh/cask/copilot-cli) (macOS and Linux):

```bash
npm install -g @github/copilot
brew install copilot-cli
```

```bash
npm install -g @github/copilot@prerelease
brew install copilot-cli@prerelease
```

Install with the install script (macOS and Linux):

Install with [WinGet](https://github.com/microsoft/winget-cli) (Windows):

```bash
curl -fsSL https://gh.io/copilot-install | bash
winget install GitHub.Copilot
```

Or

```bash
wget -qO- https://gh.io/copilot-install | bash
winget install GitHub.Copilot.Prerelease
```

Use `| sudo bash` to run as root and install to `/usr/local/bin`.

Set `PREFIX` to install to `$PREFIX/bin/` directory. Defaults to `/usr/local`
when run as root or `$HOME/.local` when run as a non-root user.

Set `VERSION` to install a specific version. Defaults to the latest version.
Install with [npm](https://www.npmjs.com/package/@github/copilot) (macOS, Linux, and Windows):

For example, to install version `v0.0.369` to a custom directory:
```bash
npm install -g @github/copilot
```

```bash
curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash
npm install -g @github/copilot@prerelease
```


### Launching the CLI

```bash
Expand Down Expand Up @@ -186,6 +189,6 @@ For more information, see the [changelog](./changelog.md).

We're excited to have you join us early in the Copilot CLI journey.

This is an early-stage preview, and we're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes!
We're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes!

Your insights are invaluable! Open issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey!
Your insights are invaluable! Open an issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey!