Skip to content

Add comprehensive SDK documentation #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patniko merged 13 commits into from
Feb 4, 2026
Merged

Add comprehensive SDK documentation #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
dddbedc
Add debugging guides and reorganize MCP docs
patniko Feb 4, 2026
ebe43ec
Add comprehensive hooks documentation
patniko Feb 4, 2026
cb149da
Add SDK/CLI compatibility documentation
patniko Feb 4, 2026
8a81ee8
Add documentation maintenance agent
patniko Feb 4, 2026
ad4cf2a
Update docs-maintenance agent to output plan only
patniko Feb 4, 2026
7279c6f
Add authentication documentation with BYOK guide
patniko Feb 4, 2026
1b1d8fb
Fix infiniteSessions example to use correct property names
patniko Feb 4, 2026
d6f6652
Add session persistence and resume guide
patniko Feb 4, 2026
0336993
Convert ASCII diagrams to Mermaid for GitHub rendering
patniko Feb 4, 2026
11cc4d7
Improve Mermaid diagrams: horizontal layout, cleaner colors
patniko Feb 4, 2026
c8b52e7
Fix documentation issues from PR review
patniko Feb 4, 2026
832ef77
Fix more documentation issues from PR review
patniko Feb 4, 2026
7f36948
Simplify docs agent: just create file, let platform handle PR
patniko Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
462 changes: 462 additions & 0 deletions .github/agents/docs-maintenance.agent.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,19 @@ Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI

### Does it support BYOK (Bring Your Own Key)?

Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure, Anthropic) to access models through those providers. Refer to the individual SDK documentation for instructions on setting up BYOK.
Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure AI Foundry, Anthropic) to access models through those providers. See the **[BYOK documentation](./docs/auth/byok.md)** for setup instructions and examples.

**Note:** BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported.

### What authentication methods are supported?

The SDK supports multiple authentication methods:
- **GitHub signed-in user** - Uses stored OAuth credentials from `copilot` CLI login
- **OAuth GitHub App** - Pass user tokens from your GitHub OAuth app
- **Environment variables** - `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, `GITHUB_TOKEN`
- **BYOK** - Use your own API keys (no GitHub auth required)

See the **[Authentication documentation](./docs/auth/index.md)** for details on each method.

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

Expand Down Expand Up @@ -96,6 +108,7 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag
## Quick Links

- **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running
- **[Authentication](./docs/auth/index.md)** – GitHub OAuth, BYOK, and more
- **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages
- **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources

Expand Down
Loading