From 43e6fdb64fb18c8e195148c49d67e508977ef744 Mon Sep 17 00:00:00 2001 From: Scott Addie Date: Thu, 11 Jun 2026 15:07:27 -0500 Subject: [PATCH 1/8] Update .NET README prerequisites Move the .NET README requirements section above installation, rename it to prerequisites, and clarify the runtime requirement as any .NET Standard 2.0-compatible implementation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- dotnet/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dotnet/README.md b/dotnet/README.md index 9b266421f..dd1672bbf 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -2,6 +2,11 @@ SDK for programmatic control of GitHub Copilot CLI. +## Prerequisites + +- Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) +- GitHub Copilot CLI installed and in PATH (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) + ## Installation ```bash @@ -982,11 +987,6 @@ catch (Exception ex) } ``` -## Requirements - -- .NET 8.0 or later -- GitHub Copilot CLI installed and in PATH (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) - ## License MIT From d715e4ce7f2c007e4fb576ac557660c71d7c50d7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 11 Jun 2026 22:05:16 +0000 Subject: [PATCH 2/8] Apply consistent Prerequisites sections across all SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- go/README.md | 5 +++++ java/README.md | 6 +++--- nodejs/README.md | 10 +++++----- python/README.md | 10 +++++----- rust/README.md | 5 +++++ 5 files changed, 23 insertions(+), 13 deletions(-) diff --git a/go/README.md b/go/README.md index 0ceaabb73..596d34751 100644 --- a/go/README.md +++ b/go/README.md @@ -2,6 +2,11 @@ A Go SDK for programmatic access to the GitHub Copilot CLI. +## Prerequisites + +- Go 1.24 or later +- GitHub Copilot CLI installed and in `PATH` (or set `COPILOT_CLI_PATH`) + ## Installation ```bash diff --git a/java/README.md b/java/README.md index dd778271b..c984e955d 100644 --- a/java/README.md +++ b/java/README.md @@ -15,13 +15,13 @@ Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build AI-powered applications and agentic workflows. The Java SDK tracks the official GitHub Copilot SDK family (TypeScript, Python, Go, .NET, and Rust). -## Installation - -### Runtime requirements +## Prerequisites - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor. - GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`) +## Installation + ### Maven Replace `${copilot.sdk.version}` with the latest release from Maven Central. diff --git a/nodejs/README.md b/nodejs/README.md index 4219d3bc2..d3bfc0ac8 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -2,6 +2,11 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. +## Prerequisites + +- Node.js ^20.19.0 or >=22.12.0 +- GitHub Copilot CLI installed and in PATH (or provide a custom `connection`) + ## Installation ```bash @@ -1033,11 +1038,6 @@ try { } ``` -## Requirements - -- Node.js ^20.19.0 or >=22.12.0 -- GitHub Copilot CLI installed and in PATH (or provide a custom `connection`) - ## License MIT diff --git a/python/README.md b/python/README.md index a916f98ec..5ccc0ab45 100644 --- a/python/README.md +++ b/python/README.md @@ -2,6 +2,11 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. +## Prerequisites + +- Python 3.11+ +- GitHub Copilot CLI installed and accessible + ## Installation ```bash @@ -897,8 +902,3 @@ When `on_elicitation_request` is provided, the SDK automatically: - Reports the `elicitation` capability on the session - Dispatches `elicitation.requested` events to your handler - Auto-cancels if your handler throws an error (so the server doesn't hang) - -## Requirements - -- Python 3.11+ -- GitHub Copilot CLI installed and accessible diff --git a/rust/README.md b/rust/README.md index 0b5bec1cd..154bc398c 100644 --- a/rust/README.md +++ b/rust/README.md @@ -6,6 +6,11 @@ See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivale **Releases:** [github.com/github/copilot-sdk/releases?q=rust%2F](https://github.com/github/copilot-sdk/releases?q=rust%2F) — per-version release notes for the Rust crate. +## Prerequisites + +- Rust 1.94.0 or later +- GitHub Copilot CLI: bundled by default via the `bundled-cli` feature (see [Features](#features)); or supply via `COPILOT_CLI_PATH` + ## Quick Start ```rust,no_run From 92fd9ac678a8e7716f42b2db2214c3214abe1368 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 11 Jun 2026 22:37:57 +0000 Subject: [PATCH 3/8] Update Python README CLI prerequisite to match other SDKs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- python/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/README.md b/python/README.md index 5ccc0ab45..da0d005e8 100644 --- a/python/README.md +++ b/python/README.md @@ -5,7 +5,7 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites - Python 3.11+ -- GitHub Copilot CLI installed and accessible +- GitHub Copilot CLI installed and in PATH (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) ## Installation From 6ed8ea375677c23d1b2b65dc79c0656b566de046 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 11 Jun 2026 22:48:03 +0000 Subject: [PATCH 4/8] Fix trailing period typo in Java README CLI version string Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- java/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/java/README.md b/java/README.md index c984e955d..1c0b9a805 100644 --- a/java/README.md +++ b/java/README.md @@ -18,7 +18,7 @@ Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build A ## Prerequisites - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor. -- GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`) +- GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`) ## Installation From 9bedf642d9a71429c9e4c8f9728b2f33f5a4fcb0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 11 Jun 2026 22:57:45 +0000 Subject: [PATCH 5/8] Standardize PATH formatting in Prerequisites sections across all READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- dotnet/README.md | 2 +- nodejs/README.md | 2 +- python/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dotnet/README.md b/dotnet/README.md index dd1672bbf..e313e3655 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -5,7 +5,7 @@ SDK for programmatic control of GitHub Copilot CLI. ## Prerequisites - Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) -- GitHub Copilot CLI installed and in PATH (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) +- GitHub Copilot CLI installed and in `PATH` (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) ## Installation diff --git a/nodejs/README.md b/nodejs/README.md index d3bfc0ac8..b2cba1b1f 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -5,7 +5,7 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites - Node.js ^20.19.0 or >=22.12.0 -- GitHub Copilot CLI installed and in PATH (or provide a custom `connection`) +- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection`) ## Installation diff --git a/python/README.md b/python/README.md index da0d005e8..b7a7caf78 100644 --- a/python/README.md +++ b/python/README.md @@ -5,7 +5,7 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites - Python 3.11+ -- GitHub Copilot CLI installed and in PATH (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) +- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) ## Installation From f6641f75bf3e4203113ab70390496d6573120ab1 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Jun 2026 15:24:38 +0000 Subject: [PATCH 6/8] Remove .NET CLI prereq and add "To use the SDK:" lead-in text to all SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- dotnet/README.md | 3 ++- go/README.md | 2 ++ java/README.md | 2 ++ nodejs/README.md | 2 ++ python/README.md | 2 ++ rust/README.md | 2 ++ 6 files changed, 12 insertions(+), 1 deletion(-) diff --git a/dotnet/README.md b/dotnet/README.md index e313e3655..6ad1bc984 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -4,8 +4,9 @@ SDK for programmatic control of GitHub Copilot CLI. ## Prerequisites +To use the SDK: + - Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) -- GitHub Copilot CLI installed and in `PATH` (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) ## Installation diff --git a/go/README.md b/go/README.md index 596d34751..f50737711 100644 --- a/go/README.md +++ b/go/README.md @@ -4,6 +4,8 @@ A Go SDK for programmatic access to the GitHub Copilot CLI. ## Prerequisites +To use the SDK: + - Go 1.24 or later - GitHub Copilot CLI installed and in `PATH` (or set `COPILOT_CLI_PATH`) diff --git a/java/README.md b/java/README.md index 1c0b9a805..cd1a24619 100644 --- a/java/README.md +++ b/java/README.md @@ -17,6 +17,8 @@ Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build A ## Prerequisites +To use the SDK: + - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor. - GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`) diff --git a/nodejs/README.md b/nodejs/README.md index b2cba1b1f..d28ea8dff 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -4,6 +4,8 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites +To use the SDK: + - Node.js ^20.19.0 or >=22.12.0 - GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection`) diff --git a/python/README.md b/python/README.md index b7a7caf78..a289b7732 100644 --- a/python/README.md +++ b/python/README.md @@ -4,6 +4,8 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites +To use the SDK: + - Python 3.11+ - GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) diff --git a/rust/README.md b/rust/README.md index 154bc398c..55179d76b 100644 --- a/rust/README.md +++ b/rust/README.md @@ -8,6 +8,8 @@ See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivale ## Prerequisites +To use the SDK: + - Rust 1.94.0 or later - GitHub Copilot CLI: bundled by default via the `bundled-cli` feature (see [Features](#features)); or supply via `COPILOT_CLI_PATH` From 903be53b2589e0377cd537960cbc0086ee2ca827 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Jun 2026 15:45:10 +0000 Subject: [PATCH 7/8] Update lead-in text to "To use the SDK, you'll need:" across all SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- dotnet/README.md | 2 +- go/README.md | 2 +- java/README.md | 2 +- nodejs/README.md | 2 +- python/README.md | 2 +- rust/README.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/dotnet/README.md b/dotnet/README.md index 6ad1bc984..4205ed90a 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -4,7 +4,7 @@ SDK for programmatic control of GitHub Copilot CLI. ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) diff --git a/go/README.md b/go/README.md index f50737711..863dbc460 100644 --- a/go/README.md +++ b/go/README.md @@ -4,7 +4,7 @@ A Go SDK for programmatic access to the GitHub Copilot CLI. ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Go 1.24 or later - GitHub Copilot CLI installed and in `PATH` (or set `COPILOT_CLI_PATH`) diff --git a/java/README.md b/java/README.md index cd1a24619..7c7209bc8 100644 --- a/java/README.md +++ b/java/README.md @@ -17,7 +17,7 @@ Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build A ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor. - GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`) diff --git a/nodejs/README.md b/nodejs/README.md index d28ea8dff..2bbd0ccd6 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -4,7 +4,7 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Node.js ^20.19.0 or >=22.12.0 - GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection`) diff --git a/python/README.md b/python/README.md index a289b7732..ecca6227a 100644 --- a/python/README.md +++ b/python/README.md @@ -4,7 +4,7 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Python 3.11+ - GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) diff --git a/rust/README.md b/rust/README.md index 55179d76b..2a49358d1 100644 --- a/rust/README.md +++ b/rust/README.md @@ -8,7 +8,7 @@ See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivale ## Prerequisites -To use the SDK: +To use the SDK, you'll need: - Rust 1.94.0 or later - GitHub Copilot CLI: bundled by default via the `bundled-cli` feature (see [Features](#features)); or supply via `COPILOT_CLI_PATH` From c4aa156bb3b5bf5075c955ddd6907e463c475240 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Jun 2026 19:02:52 +0000 Subject: [PATCH 8/8] Remove bundled CLI prereq from Node.js, Python, and Rust READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --- nodejs/README.md | 1 - python/README.md | 1 - rust/README.md | 1 - 3 files changed, 3 deletions(-) diff --git a/nodejs/README.md b/nodejs/README.md index f5a3cd7bf..09569e7c2 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -7,7 +7,6 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. To use the SDK, you'll need: - Node.js ^20.19.0 or >=22.12.0 -- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection`) ## Installation diff --git a/python/README.md b/python/README.md index ed93fd041..c7b6dee0c 100644 --- a/python/README.md +++ b/python/README.md @@ -7,7 +7,6 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. To use the SDK, you'll need: - Python 3.11+ -- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`) ## Installation diff --git a/rust/README.md b/rust/README.md index bc91367b6..39878dceb 100644 --- a/rust/README.md +++ b/rust/README.md @@ -11,7 +11,6 @@ See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivale To use the SDK, you'll need: - Rust 1.94.0 or later -- GitHub Copilot CLI: bundled by default via the `bundled-cli` feature (see [Features](#features)); or supply via `COPILOT_CLI_PATH` ## Quick Start