Skip to content

Commit a5797c9

Browse files
committed
docs: add LSP server configuration guide to README
1 parent 1bc2c29 commit a5797c9

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,64 @@ Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premi
122122

123123
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).
124124

125+
## 🔧 Configuring LSP Servers
126+
127+
GitHub Copilot CLI supports Language Server Protocol (LSP) for enhanced code intelligence. This feature is currently experimental and provides intelligent code features like go-to-definition, hover information, and diagnostics.
128+
129+
### Enabling LSP Support
130+
131+
To use LSP features, you must enable experimental mode:
132+
133+
```bash
134+
copilot --experimental
135+
```
136+
137+
Or use the `/experimental` command within an interactive session.
138+
139+
### Installing Language Servers
140+
141+
Copilot CLI does not bundle LSP servers. You need to install them separately. For example, to set up TypeScript support:
142+
143+
```bash
144+
npm install -g typescript-language-server
145+
```
146+
147+
For other languages, install the corresponding LSP server and configure it following the same pattern shown below.
148+
149+
### Configuring LSP Servers
150+
151+
LSP servers are configured through a dedicated LSP configuration file. You can configure LSP servers at the user level or repository level:
152+
153+
**User-level configuration** (applies to all projects):
154+
Edit `~/.copilot/lsp-config.json`
155+
156+
**Repository-level configuration** (applies to specific project):
157+
Create `.github/lsp.json` in your repository root
158+
159+
Example configuration:
160+
161+
```json
162+
{
163+
"lspServers": {
164+
"typescript": {
165+
"command": "typescript-language-server",
166+
"args": ["--stdio"],
167+
"disabled": false,
168+
"fileExtensions": {
169+
".ts": "typescript",
170+
".tsx": "typescript"
171+
}
172+
}
173+
}
174+
}
175+
```
176+
177+
### Viewing LSP Server Status
178+
179+
Check configured LSP servers using the `/lsp` command in an interactive session, or view your configuration files directly.
180+
181+
For more information, see the [changelog](./changelog.md).
182+
125183
## 📢 Feedback and Participation
126184

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

0 commit comments

Comments
 (0)