Skip to content

Commit 0afd874

Browse files
Refactor README by removing installation instructions
docs: add GitHub Copilot CLI documentation - Include overview, installation, authentication, LSP configuration - Provide usage instructions and experimental features
1 parent 3e316bb commit 0afd874

1 file changed

Lines changed: 0 additions & 151 deletions

File tree

README.md

Lines changed: 0 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ See [our official documentation](https://docs.github.com/copilot/concepts/agents
88

99
![Image of the splash screen for the Copilot CLI](https://github.com/user-attachments/assets/f40aa23d-09dd-499e-9457-1d57d3368887)
1010

11-
1211
## 🚀 Introduction and Overview
1312

1413
We're bringing the power of GitHub Copilot coding agent directly to your terminal. With GitHub Copilot CLI, you can work locally and synchronously with an AI agent that understands your code and GitHub context.
@@ -42,153 +41,3 @@ Install with the install script (macOS and Linux):
4241

4342
```bash
4443
curl -fsSL https://gh.io/copilot-install | bash
45-
```
46-
47-
Or
48-
49-
```bash
50-
wget -qO- https://gh.io/copilot-install | bash
51-
```
52-
53-
Use `| sudo bash` to run as root and install to `/usr/local/bin`.
54-
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:
61-
62-
```bash
63-
curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash
64-
```
65-
66-
Install with [Homebrew](https://formulae.brew.sh/cask/copilot-cli) (macOS and Linux):
67-
68-
```bash
69-
brew install copilot-cli
70-
```
71-
72-
```bash
73-
brew install copilot-cli@prerelease
74-
```
75-
76-
77-
Install with [WinGet](https://github.com/microsoft/winget-cli) (Windows):
78-
79-
```bash
80-
winget install GitHub.Copilot
81-
```
82-
83-
```bash
84-
winget install GitHub.Copilot.Prerelease
85-
```
86-
87-
88-
Install with [npm](https://www.npmjs.com/package/@github/copilot) (macOS, Linux, and Windows):
89-
90-
```bash
91-
npm install -g @github/copilot
92-
```
93-
94-
```bash
95-
npm install -g @github/copilot@prerelease
96-
```
97-
98-
99-
### Launching the CLI
100-
101-
```bash
102-
copilot
103-
```
104-
105-
On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag.
106-
107-
If you're not currently logged in to GitHub, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate.
108-
109-
#### Authenticate with a Personal Access Token (PAT)
110-
111-
You can also authenticate using a fine-grained PAT with the "Copilot Requests" permission enabled.
112-
113-
1. Visit https://github.com/settings/personal-access-tokens/new
114-
2. Under "Permissions," click "add permissions" and select "Copilot Requests"
115-
3. Generate your token
116-
4. Add the token to your environment via the environment variable `GH_TOKEN` or `GITHUB_TOKEN` (in order of precedence)
117-
118-
### Using the CLI
119-
120-
Launch `copilot` in a folder that contains code you want to work with.
121-
122-
By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5.
123-
124-
### Experimental Mode
125-
126-
Experimental mode enables access to new features that are still in development. You can activate experimental mode by:
127-
128-
- Launching with the `--experimental` flag: `copilot --experimental`
129-
- Using the `/experimental` slash command from within the CLI
130-
131-
Once activated, the setting is persisted in your config, so the `--experimental` flag is no longer needed on subsequent launches.
132-
133-
#### Experimental Features
134-
135-
- **Autopilot mode:** Autopilot is a new mode (press `Shift+Tab` to cycle through modes), which encourages the agent to continue working until a task is completed.
136-
137-
Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premium requests is reduced by one. For information about premium requests, see [About premium requests](https://docs.github.com/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests).
138-
139-
For more information about how to use the GitHub Copilot CLI, see [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli).
140-
141-
## 🔧 Configuring LSP Servers
142-
143-
GitHub Copilot CLI supports Language Server Protocol (LSP) for enhanced code intelligence. This feature provides intelligent code features like go-to-definition, hover information, and diagnostics.
144-
145-
### Installing Language Servers
146-
147-
Copilot CLI does not bundle LSP servers. You need to install them separately. For example, to set up TypeScript support:
148-
149-
```bash
150-
npm install -g typescript-language-server
151-
```
152-
153-
For other languages, install the corresponding LSP server and configure it following the same pattern shown below.
154-
155-
### Configuring LSP Servers
156-
157-
LSP servers are configured through a dedicated LSP configuration file. You can configure LSP servers at the user level or repository level:
158-
159-
**User-level configuration** (applies to all projects):
160-
Edit `~/.copilot/lsp-config.json`
161-
162-
**Repository-level configuration** (applies to specific project):
163-
Create `.github/lsp.json` in your repository root
164-
165-
Example configuration:
166-
167-
```json
168-
{
169-
"lspServers": {
170-
"typescript": {
171-
"command": "typescript-language-server",
172-
"args": ["--stdio"],
173-
"fileExtensions": {
174-
".ts": "typescript",
175-
".tsx": "typescript"
176-
}
177-
}
178-
}
179-
}
180-
```
181-
182-
### Viewing LSP Server Status
183-
184-
Check configured LSP servers using the `/lsp` command in an interactive session, or view your configuration files directly.
185-
186-
For more information, see the [changelog](./changelog.md).
187-
188-
## 📢 Feedback and Participation
189-
190-
We're excited to have you join us early in the Copilot CLI journey.
191-
192-
We're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes!
193-
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)