Skip to content

Commit 53f40f6

Browse files
committed
docs: updated Github Copilot extension README
1 parent b181d6d commit 53f40f6

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

packages/extensions/extensions/github-copilot/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Integrates [GitHub Copilot](https://github.com/features/copilot) as an LLM provi
55
## How It Works
66

77
1. Registers `github-copilot` as an LLM provider in AiderDesk
8-
2. Uses the official `@github/copilot-sdk` which bundles the Copilot CLI binary
8+
2. Uses the official `@github/copilot-sdk` which spawns the Copilot CLI as a child process
99
3. The CLI handles all model routing (Responses API, Chat Completions, Messages API), authentication, and endpoint selection internally
1010
4. Forwards AiderDesk's tools to the Copilot agent via `defineTool`
1111
5. The user authenticates once via the Copilot CLI (keychain credentials)
1212

1313
## Prerequisites
1414

15-
- **Copilot CLI**: The CLI is bundled with this extension — no separate installation needed
16-
- **Authentication**: Run the Copilot CLI once to authenticate, or ensure you have stored credentials
15+
- **Copilot CLI**: Install it manually from [github.com/features/copilot/cli](https://github.com/features/copilot/cli). You only need it to authenticate — the extension bundles its own CLI binary for runtime use.
16+
- **Authentication**: Run `copilot` in your terminal once to authenticate before using this provider
1717
- **Copilot Subscription**: Active GitHub Copilot subscription (Individual, Business, or Enterprise)
1818

1919
## Mode Support
@@ -42,10 +42,11 @@ No additional configuration is needed. Once the extension is installed and the C
4242

4343
**Provider Not Available**:
4444
1. Verify the extension is installed and enabled in AiderDesk
45-
2. Check that the Copilot CLI can authenticate (run `copilot` in your terminal)
45+
2. Ensure the Copilot CLI is installed (see [github.com/features/copilot/cli](https://github.com/features/copilot/cli))
46+
3. Check that the Copilot CLI can authenticate (run `copilot` in your terminal)
4647

4748
**Authentication Fails**:
48-
1. Run `copilot` in your terminal to re-authenticate
49+
1. Run `copilot` in your terminal to re-authenticate (ensure the CLI is installed)
4950
2. Check that your Copilot subscription is active
5051

5152
**Model Not Supported**:

packages/extensions/extensions/github-copilot/package-lock.json

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)