Merge main into jm/infinite, update protocol to v2

Author: jmoseley

.github/workflows/sdk-e2e-tests.yml

@@ -111,7 +111,7 @@ jobs:
         env:
           COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
           COPILOT_CLI_PATH: ${{ steps.cli-path.outputs.path }}
-        run: ./test.sh
+        run: /bin/bash test.sh
 
   python-sdk:
     name: "Python SDK Tests"

CONTRIBUTING.md

@@ -26,7 +26,7 @@ Currently **we are not looking to add SDKs for other languages**. If you want to
 This is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on:
 
 ### All SDKs
-1. Install [just](https://github.com/casey/just) command runner
+1. (Optional) Install [just](https://github.com/casey/just) command runner for convenience
 
 ### Node.js/TypeScript SDK
 1. Install [Node.js](https://nodejs.org/) (v18+)
@@ -44,7 +44,13 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl
 
 ### .NET SDK
 1. Install [.NET 8.0+](https://dotnet.microsoft.com/download)
-1. Install dependencies: `cd dotnet && dotnet restore`
+1. Install [Node.js](https://nodejs.org/) (v18+) (the .NET tests depend on a TypeScript-based test harness)
+1. Install npm dependencies (from the repository root):
+   ```bash
+   cd nodejs && npm ci
+   cd test/harness && npm ci
+   ```
+1. Install .NET dependencies: `cd dotnet && dotnet restore`
 
 ## Submitting a pull request
 
@@ -59,7 +65,7 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl
 
 ### Running tests and linters
 
-Use `just` to run tests and linters across all SDKs or for specific languages:
+If you installed `just`, you can use it to run tests and linters across all SDKs or for specific languages:
 
 ```bash
 # All SDKs

README.md

@@ -1,22 +1,31 @@
-# Copilot CLI SDKs
+# GitHub Copilot CLI SDKs
 
-Language-specific SDKs for programmatic access to the GitHub Copilot CLI.
+![GitHub Copilot SDK](./assets/RepoHeader_01.png)
 
-All SDKs are in technical preview and may change in breaking ways as we move towards a stable release.
+Agents for every app.
+
+Embed Copilot's agentic workflows in your application—now available in Technical preview as a programmable SDK for Python, TypeScript, Go, and .NET.
+
+The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-tested agent runtime you can invoke programmatically. No need to build your own orchestration—you define agent behavior, Copilot handles planning, tool invocation, file edits, and more.
 
 ## Available SDKs
 
-| SDK                      | Location                          | Installation                              |
-| ------------------------ | --------------------------------- | ----------------------------------------- |
-| **Node.js / TypeScript** | [`./nodejs/`](./nodejs/README.md) | `npm install @github/copilot-sdk`         |
-| **Python**               | [`./python/`](./python/README.md) | `pip install github-copilot-sdk`          |
-| **Go**                   | [`./go/`](./go/README.md)         | `go get github.com/github/copilot-sdk/go` |
-| **.NET**                 | [`./dotnet/`](./dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK`   |
+| SDK                      | Location                          | Installation                               |
+| ------------------------ | --------------------------------- | ------------------------------------------ |
+| **Node.js / TypeScript** | [`./nodejs/`](./nodejs/README.md) | `npm install @github/copilot-sdk`          |
+| **Python**               | [`./python/`](./python/README.md) | `pip install github-copilot-sdk`           |
+| **Go**                   | [`./go/`](./go/README.md)         | `go get github.com/github/copilot-sdk/go`  |
+| **.NET**                 | [`./dotnet/`](./dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK`    |
+| **Rust**                 | [`./rust/`](./rust/README.md)     | `cargo add github-copilot-sdk`             |
 
 See the individual SDK READMEs for installation, usage examples, and API reference.
 
 ## Getting Started
 
+For a complete walkthrough, see the **[Getting Started Guide](./docs/getting-started.md)**.
+
+Quick steps:
+
 1. **Install the Copilot CLI:**
 
    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.
@@ -39,6 +48,54 @@ Your Application
 
 The SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see individual SDK docs for details.
 
+## FAQ
+
+### Do I need a GitHub Copilot subscription to use the SDK?
+
+Yes, a GitHub Copilot subscription is required to use the GitHub Copilot SDK. Refer to the [GitHub Copilot pricing page](https://github.com/features/copilot#pricing). You can use the free tier of the Copilot CLI, which includes limited usage.
+
+### How does billing work for SDK usage?
+
+Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your premium request quota. For more information on premium requests, see [Requests in GitHub Copilot](https://docs.github.com/en/copilot/concepts/billing/copilot-requests).
+
+### Does it support BYOK (Bring Your Own Key)?
+
+Yes, the GitHub Copilot SDK supports BYOK. You can configure the SDK to use your own encryption keys for data security. Refer to the individual SDK documentation for instructions on setting up BYOK.
+
+### 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.
+
+### What tools are enabled by default?
+
+By default, the SDK will operate the Copilot CLI in the equivalent of `--allow-all` being passed to the CLI, enabling all first-party tools, which means that the agents can perform a wide range of actions, including file system operations, Git operations, and web requests. You can customize tool availability by configuring the SDK client options to enable and disable specific tools. Refer to the individual SDK documentation for details on tool configuration and Copilot CLI for the list of tools available.
+
+### Can I use custom agents, skills or tools?
+
+Yes, the GitHub Copilot SDK allows you to define custom agents, skills, and tools. You can extend the functionality of the agents by implementing your own logic and integrating additional tools as needed. Refer to the SDK documentation of your preferred language for more details.
+
+### Are there instructions for Copilot to speed up development with the SDK?
+
+Yes, check out the custom instructions at [`github/awesome-copilot`](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md).
+
+### What models are supported?
+
+All models available via Copilot CLI are supported in the SDK. The SDK also exposes a method which will return the models available so they can be accessed at runtime.
+
+### Is the SDK production-ready?
+
+The GitHub Copilot SDK is currently in Technical Preview. While it is functional and can be used for development and testing, it may not yet be suitable for production use.
+
+### How do I report issues or request features?
+
+Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) page to report bugs or request new features. We welcome your feedback to help improve the SDK.
+
+## Quick Links
+
+- **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running
+- **[Cookbook](./cookbook/README.md)** – Practical recipes for common tasks across all languages
+- **[Samples](./samples/README.md)** – Video walkthroughs and sample projects
+
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.

assets/RepoHeader_01.png

@@ -0,0 +1,86 @@
+# 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](dotnet/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
+- [Multiple Sessions](dotnet/multiple-sessions.md): Manage multiple independent conversations simultaneously.
+- [Managing Local Files](dotnet/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
+- [PR Visualization](dotnet/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
+- [Persisting Sessions](dotnet/persisting-sessions.md): Save and resume sessions across restarts.
+
+### Node.js / TypeScript
+
+- [Error Handling](nodejs/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
+- [Multiple Sessions](nodejs/multiple-sessions.md): Manage multiple independent conversations simultaneously.
+- [Managing Local Files](nodejs/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
+- [PR Visualization](nodejs/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
+- [Persisting Sessions](nodejs/persisting-sessions.md): Save and resume sessions across restarts.
+
+### Python
+
+- [Error Handling](python/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
+- [Multiple Sessions](python/multiple-sessions.md): Manage multiple independent conversations simultaneously.
+- [Managing Local Files](python/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
+- [PR Visualization](python/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
+- [Persisting Sessions](python/persisting-sessions.md): Save and resume sessions across restarts.
+
+### Go
+
+- [Error Handling](go/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
+- [Multiple Sessions](go/multiple-sessions.md): Manage multiple independent conversations simultaneously.
+- [Managing Local Files](go/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
+- [PR Visualization](go/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
+- [Persisting Sessions](go/persisting-sessions.md): 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`
+
+## Running Examples
+
+### .NET
+
+```bash
+cd dotnet/cookbook/recipe
+dotnet run <filename>.cs
+```
+
+### Node.js
+
+```bash
+cd nodejs/cookbook/recipe
+npm install
+npx tsx <filename>.ts
+```
+
+### Python
+
+```bash
+cd python/cookbook/recipe
+pip install -r requirements.txt
+python <filename>.py
+```
+
+### Go
+
+```bash
+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 in `recipe/`
+- Follow repository guidance in [CONTRIBUTING.md](../CONTRIBUTING.md)
+
+## Status
+
+Cookbook structure is complete with 4 recipes across all 4 supported languages. Each recipe includes both markdown documentation and runnable examples.

cookbook/README.md

@@ -0,0 +1,19 @@
+# GitHub Copilot SDK Cookbook — .NET (C#)
+
+This folder hosts short, practical recipes for using the GitHub Copilot SDK with .NET. Each recipe is concise, copy‑pasteable, and points to fuller examples and tests.
+
+## Recipes
+
+- [Error Handling](error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
+- [Multiple Sessions](multiple-sessions.md): Manage multiple independent conversations simultaneously.
+- [Managing Local Files](managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
+- [PR Visualization](pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
+- [Persisting Sessions](persisting-sessions.md): Save and resume sessions across restarts.
+
+## Contributing
+
+Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md).
+
+## Status
+
+This README is a scaffold; recipe files are placeholders until populated.