⚠️ Disclaimer: This is an unofficial, community-driven SDK and is not supported or endorsed by GitHub. This SDK may change in breaking ways. Use at your own risk.
Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build AI-powered applications and agentic workflows.
<dependency>
<groupId>io.github.copilot-community-sdk</groupId>
<artifactId>copilot-sdk</artifactId>
<version>1.0.4</version>
</dependency>implementation 'io.github.copilot-community-sdk:copilot-sdk:1.0.4'import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) throws Exception {
try (var client = new CopilotClient()) {
client.start().get();
var session = client.createSession(
new SessionConfig().setModel("claude-sonnet-4.5")
).get();
var done = new CompletableFuture<Void>();
session.on(evt -> {
if (evt instanceof AssistantMessageEvent msg) {
System.out.println(msg.getData().getContent());
} else if (evt instanceof SessionIdleEvent) {
done.complete(null);
}
});
session.send(new MessageOptions().setPrompt("What is 2+2?")).get();
done.get();
}
}
}📚 Full Documentation — Complete API reference, advanced usage examples, and guides.
- Java 17 or later
- GitHub Copilot CLI installed and in PATH (or provide custom
cliPath)
| Project | Description |
|---|---|
| JMeter Copilot Plugin | JMeter plugin for AI-assisted load testing |
Want to add your project? Open a PR!
Contributions are welcome! Please see the Contributing Guide for details.
# Clone the repository
git clone https://github.com/copilot-community-sdk/copilot-sdk-java.git
cd copilot-sdk-java
# Enable git hooks for code formatting
git config core.hooksPath .githooks
# Build and test
mvn clean verifyThe tests require the official copilot-sdk test harness, which is automatically cloned during build.
MIT — see LICENSE for details.