Skip to content

Commit f8396ae

Browse files
authored
Merge pull request #1670 from github/RyanHecht-patch-1
README updates
2 parents 6c3eff1 + b54e97c commit f8396ae

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GitHub Copilot CLI (Public Preview)
1+
# GitHub Copilot CLI
22

33
The power of GitHub Copilot, now in your terminal.
44

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

3939
### Installation
4040

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

4343
```bash
44-
winget install GitHub.Copilot
44+
curl -fsSL https://gh.io/copilot-install | bash
4545
```
4646

47+
Or
48+
4749
```bash
48-
winget install GitHub.Copilot.Prerelease
50+
wget -qO- https://gh.io/copilot-install | bash
4951
```
5052

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

53-
```bash
54-
brew install copilot-cli
55-
```
55+
Set `PREFIX` to install to `$PREFIX/bin/` directory. Defaults to `/usr/local`
56+
when run as root or `$HOME/.local` when run as a non-root user.
57+
58+
Set `VERSION` to install a specific version. Defaults to the latest version.
59+
60+
For example, to install version `v0.0.369` to a custom directory:
5661

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

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

6368
```bash
64-
npm install -g @github/copilot
69+
brew install copilot-cli
6570
```
6671

6772
```bash
68-
npm install -g @github/copilot@prerelease
73+
brew install copilot-cli@prerelease
6974
```
7075

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

7379
```bash
74-
curl -fsSL https://gh.io/copilot-install | bash
80+
winget install GitHub.Copilot
7581
```
7682

77-
Or
78-
7983
```bash
80-
wget -qO- https://gh.io/copilot-install | bash
84+
winget install GitHub.Copilot.Prerelease
8185
```
8286

83-
Use `| sudo bash` to run as root and install to `/usr/local/bin`.
84-
85-
Set `PREFIX` to install to `$PREFIX/bin/` directory. Defaults to `/usr/local`
86-
when run as root or `$HOME/.local` when run as a non-root user.
8787

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

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

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

98+
9699
### Launching the CLI
97100

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

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

189-
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!
192+
We're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes!
190193

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

0 commit comments

Comments
 (0)