mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 02:15:12 +00:00
5eb7adb376
All 5 Go recipes and their markdown docs used incorrect API patterns that don't match the real github.com/github/copilot-sdk/go v0.1.23: - copilot.NewClient() -> copilot.NewClient(nil) (*ClientOptions param) - client.Start() -> client.Start(ctx) (context.Context required) - copilot.SessionConfig -> &copilot.SessionConfig (pointer required) - session.On(func(event copilot.Event)) -> session.On(func(event copilot.SessionEvent)) - Type assertions -> event.Type string check + *event.Data.Content deref - session.WaitForIdle() -> session.SendAndWait(ctx, ...) (WaitForIdle doesn't exist) - copilot.SystemMessage -> copilot.SystemMessageConfig All 5 recipes verified to compile against SDK v0.1.23.
GitHub Copilot SDK Cookbook
This cookbook collects small, focused recipes showing how to accomplish common tasks with the GitHub Copilot SDK across languages. Each recipe is intentionally short and practical, with copy‑pasteable snippets and pointers to fuller examples and tests.
Recipes by Language
.NET (C#)
- Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
- Multiple Sessions: Manage multiple independent conversations simultaneously.
- Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
- PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
- Persisting Sessions: Save and resume sessions across restarts.
Node.js / TypeScript
- Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
- Multiple Sessions: Manage multiple independent conversations simultaneously.
- Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
- PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
- Persisting Sessions: Save and resume sessions across restarts.
Python
- Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
- Multiple Sessions: Manage multiple independent conversations simultaneously.
- Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
- PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
- Persisting Sessions: Save and resume sessions across restarts.
Go
- Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
- Multiple Sessions: Manage multiple independent conversations simultaneously.
- Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
- PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
- Persisting Sessions: Save and resume sessions across restarts.
How to Use
- Browse your language section above and open the recipe links
- Each recipe includes runnable examples in a
recipe/subfolder with language-specific tooling - See existing examples and tests for working references:
- Node.js examples:
nodejs/examples/basic-example.ts - E2E tests:
go/e2e,python/e2e,nodejs/test/e2e,dotnet/test/Harness
- Node.js examples:
Running Examples
.NET
cd dotnet/cookbook/recipe
dotnet run <filename>.cs
Node.js
cd nodejs/cookbook/recipe
npm install
npx tsx <filename>.ts
Python
cd python/cookbook/recipe
pip install -r requirements.txt
python <filename>.py
Go
cd go/cookbook/recipe
go run <filename>.go
Contributing
- Propose or add a new recipe by creating a markdown file in your language's
cookbook/folder and a runnable example inrecipe/ - Follow repository guidance in CONTRIBUTING.md
Status
Cookbook structure is complete with 4 recipes across all 4 supported languages. Each recipe includes both markdown documentation and runnable examples.