Skip to content

Commit 8ae873d

Browse files
scottaddieCopilotCopilotedburns
authored
Standardize README prerequisites across all SDK languages (#1636)
* 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> * Apply consistent Prerequisites sections across all SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> * Update Python README CLI prerequisite to match other SDKs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> * Fix trailing period typo in Java README CLI version string Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> * Standardize PATH formatting in Prerequisites sections across all READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> * 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> * 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> * Remove bundled CLI prereq from Node.js, Python, and Rust READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Ed Burns <edburns@microsoft.com>
1 parent 03c021d commit 8ae873d

6 files changed

Lines changed: 36 additions & 18 deletions

File tree

‎dotnet/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
SDK for programmatic control of GitHub Copilot CLI.
44

5+
## Prerequisites
6+
7+
To use the SDK, you'll need:
8+
9+
- 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)
10+
511
## Installation
612

713
```bash
@@ -1017,11 +1023,6 @@ catch (Exception ex)
10171023
}
10181024
```
10191025

1020-
## Requirements
1021-
1022-
- .NET 8.0 or later
1023-
- GitHub Copilot CLI installed and in PATH (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`)
1024-
10251026
## License
10261027

10271028
MIT

‎go/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
A Go SDK for programmatic access to the GitHub Copilot CLI.
44

5+
## Prerequisites
6+
7+
To use the SDK, you'll need:
8+
9+
- Go 1.24 or later
10+
- GitHub Copilot CLI installed and in `PATH` (or set `COPILOT_CLI_PATH`)
11+
512
## Installation
613

714
```bash

‎java/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@
1515

1616
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).
1717

18-
## Installation
18+
## Prerequisites
1919

20-
### Runtime requirements
20+
To use the SDK, you'll need:
2121

2222
- 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.
23-
- GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`)
23+
- GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`)
24+
25+
## Installation
2426

2527
### Maven
2628

‎nodejs/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.
44

5+
## Prerequisites
6+
7+
To use the SDK, you'll need:
8+
9+
- Node.js ^20.19.0 or >=22.12.0
10+
511
## Installation
612

713
```bash
@@ -1071,11 +1077,6 @@ try {
10711077
}
10721078
```
10731079

1074-
## Requirements
1075-
1076-
- Node.js ^20.19.0 or >=22.12.0
1077-
- GitHub Copilot CLI installed and in PATH (or provide a custom `connection`)
1078-
10791080
## License
10801081

10811082
MIT

‎python/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.
44

5+
## Prerequisites
6+
7+
To use the SDK, you'll need:
8+
9+
- Python 3.11+
10+
511
## Installation
612

713
```bash
@@ -923,8 +929,3 @@ When `on_elicitation_request` is provided, the SDK automatically:
923929
- Reports the `elicitation` capability on the session
924930
- Dispatches `elicitation.requested` events to your handler
925931
- Auto-cancels if your handler throws an error (so the server doesn't hang)
926-
927-
## Requirements
928-
929-
- Python 3.11+
930-
- GitHub Copilot CLI installed and accessible

‎rust/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivale
66

77
**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.
88

9+
## Prerequisites
10+
11+
To use the SDK, you'll need:
12+
13+
- Rust 1.94.0 or later
14+
915
## Quick Start
1016

1117
```rust,no_run

0 commit comments

Comments
 (0)