diff --git a/dotnet/README.md b/dotnet/README.md index 622237f82..7c21ce792 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -2,6 +2,12 @@ SDK for programmatic control of GitHub Copilot CLI. +## Prerequisites + +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) + ## Installation ```bash @@ -1016,11 +1022,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 diff --git a/go/README.md b/go/README.md index a8061c4a3..bd8c539f0 100644 --- a/go/README.md +++ b/go/README.md @@ -2,6 +2,13 @@ A Go SDK for programmatic access to the GitHub Copilot CLI. +## Prerequisites + +To use the SDK, you'll need: + +- 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..7c7209bc8 100644 --- a/java/README.md +++ b/java/README.md @@ -15,12 +15,14 @@ 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 +## Prerequisites -### Runtime requirements +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`) +- GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`) + +## Installation ### Maven diff --git a/nodejs/README.md b/nodejs/README.md index 30c529661..09569e7c2 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -2,6 +2,12 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. +## Prerequisites + +To use the SDK, you'll need: + +- Node.js ^20.19.0 or >=22.12.0 + ## Installation ```bash @@ -1070,11 +1076,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 5cebce7f3..c7b6dee0c 100644 --- a/python/README.md +++ b/python/README.md @@ -2,6 +2,12 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. +## Prerequisites + +To use the SDK, you'll need: + +- Python 3.11+ + ## Installation ```bash @@ -922,8 +928,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 2e160a3ba..39878dceb 100644 --- a/rust/README.md +++ b/rust/README.md @@ -6,6 +6,12 @@ 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 + +To use the SDK, you'll need: + +- Rust 1.94.0 or later + ## Quick Start ```rust,no_run