Skip to content

Commit 5808c6f

Browse files
committed
Docs: clarify Copilot CLI is bundled with SDKs and update installation guidance
1 parent 1587e34 commit 5808c6f

2 files changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ For a complete walkthrough, see the **[Getting Started Guide](./docs/getting-sta
3030

3131
Quick steps:
3232

33-
1. **Install the Copilot CLI:**
33+
1. **(Optional) Install the Copilot CLI**
3434

35-
Follow the [Copilot CLI installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) to install the CLI, or ensure `copilot` is available in your PATH.
35+
For Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically and no separate installation is required.
36+
For the Go SDK, install the CLI manually or ensure `copilot` is available in your PATH.
3637

3738
2. **Install your preferred SDK** using the commands above.
3839

@@ -80,7 +81,11 @@ See the **[Authentication documentation](./docs/auth/index.md)** for details on
8081

8182
### Do I need to install the Copilot CLI separately?
8283

83-
Yes, the Copilot CLI must be installed separately. The SDKs communicate with the Copilot CLI in server mode to provide agent capabilities.
84+
No — for Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically as a dependency. You do not need to install it separately.
85+
86+
For Go SDK, you may still need to install the CLI manually.
87+
88+
Advanced: You can override the bundled CLI using `cliPath` or `cliUrl` if you want to use a custom CLI binary or connect to an external server.
8489

8590
### What tools are enabled by default?
8691

docs/setup/local-cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Local CLI Setup
22

3-
Use the Copilot SDK with the CLI already signed in on your machine. This is the simplest configuration — zero auth code, zero infrastructure.
3+
Use the Copilot SDK with a Copilot CLI instance signed in on your machine. Depending on the SDK, this may be a bundled CLI (included automatically) or a system-installed CLI available in your PATH. This is the simplest configuration — zero auth code, zero infrastructure.
44

55
**Best for:** Personal projects, prototyping, local development, learning the SDK.
66

77
## How It Works
88

9-
When you install the Copilot CLI and sign in, your credentials are stored in the system keychain. The SDK automatically starts the CLI as a child process and uses those stored credentials.
9+
When a Copilot CLI instance is available (either bundled with the SDK or installed on your system) and signed in, credentials are stored in the system keychain. The SDK automatically starts the CLI as a child process and uses those stored credentials.
1010

1111
```mermaid
1212
flowchart LR
@@ -21,7 +21,7 @@ flowchart LR
2121
```
2222

2323
**Key characteristics:**
24-
- CLI is spawned automatically by the SDK (no setup needed)
24+
- CLI is spawned automatically by the SDK (using a bundled CLI or a system-installed CLI if available)
2525
- Authentication uses the signed-in user's credentials from the system keychain
2626
- Communication happens over stdio (stdin/stdout) — no network ports
2727
- Sessions are local to your machine
@@ -161,7 +161,7 @@ While defaults work great, you can customize the local setup:
161161

162162
```typescript
163163
const client = new CopilotClient({
164-
// Override CLI location (default: bundled with @github/copilot)
164+
// Override CLI location (by default, the SDK uses a bundled CLI or resolves one from your system)
165165
cliPath: "/usr/local/bin/copilot",
166166

167167
// Set log level for debugging

0 commit comments

Comments
 (0)