-
Notifications
You must be signed in to change notification settings - Fork 1.1k
README FAQ incorrectly states CLI must be installed separately #984
Description
Summary
The README FAQ contains this Q&A:
Do I need to install the Copilot CLI separately?
Yes, the Copilot CLI must be installed separately. The SDKs communicate with the Copilot CLI in server mode to provide agent capabilities.
This is incorrect for the Node.js, Python, and .NET SDKs, which bundle the CLI as a package dependency (e.g., @github/copilot for Node.js). Users do not need to install the CLI separately — it's included automatically when installing the SDK.
This was confirmed by @SteveSandersonMS in #530 (comment):
SDK consumers won't face unexpected breaking changes because the SDK (except on Go) uses its own bundled copy of Copilot CLI so isn't affected by whatever other version the user installs manually. You can still pass
cliPathto override the instance it uses, but it never looks for any version fromPATH.
Inconsistent documentation
The Getting Started guide also lists installing the CLI as a prerequisite:
GitHub Copilot CLI installed and authenticated (Installation guide)
Meanwhile, the source code (nodejs/src/client.ts) defaults to resolving the bundled @github/copilot package from node_modules via getBundledCliPath(), and package.json declares @github/copilot as a direct dependency.
Suggested fix
- Update the FAQ answer to clarify that the CLI is bundled with the SDK (except Go) and does not need separate installation
- Update the Getting Started guide to remove the CLI installation prerequisite for Node.js, Python, and .NET, or clarify it's only needed for Go
- Mention that
cliPath/cliUrloptions exist for users who want to use a different CLI binary or connect to an external server