java-coding-skill

Java Coding Skill

Core Principles

• Requires Java 25 or later for building the jar artifact for Copilot SDK for java.
• Uses the Multi-Relase jar feature JEP 238 https://openjdk.org/jeps/238 with maven.compiler.release 17 so that uses running JDK 17 can use the jar.
• Requires GitHub Copilot CLI installed and in PATH.
• Uses CompletableFuture for all async operations.
• Implements AutoCloseable for resource cleanup (try-with-resources).

Installation

Maven

<dependency>
    <groupId>com.github</groupId>
    <artifactId>copilot-sdk-java</artifactId>
    <version>${copilot-sdk-java.version}</version>
</dependency>

Gradle

implementation "com.github:copilot-sdk-java:${copilotSdkJavaVersion}"

Client Initialization

Basic Client Setup

try (var client = new CopilotClient()) {
    client.start().get();
    // Use client...
}

Client Configuration Options

When creating a CopilotClient, use CopilotClientOptions:

• cliPath - Path to CLI executable (default: "copilot" from PATH)
• cliArgs - Extra arguments prepended before SDK-managed flags
• cliUrl - URL of existing CLI server (e.g., "localhost:8080"). When provided, client won't spawn a process
• port - Server port (default: 0 for random, only when useStdio is false)
• useStdio - Use stdio transport instead of TCP (default: true)
• logLevel - Log level: "error", "warn", "info", "debug", "trace" (default: "info")
• autoStart - Auto-start server on first request (default: true)
• autoRestart - Auto-restart on crash (default: true)
• cwd - Working directory for the CLI process
• environment - Environment variables for the CLI process
• gitHubToken - GitHub token for authentication
• useLoggedInUser - Use logged-in gh CLI auth (default: true unless token provided)
• onListModels - Custom model list handler for BYOK scenarios

var options = new CopilotClientOptions()
    .setCliPath("/path/to/copilot")
    .setLogLevel("debug")
    .setAutoStart(true)
    .setAutoRestart(true)
    .setGitHubToken(System.getenv("GITHUB_TOKEN"));

try (var client = new CopilotClient(options)) {
    client.start().get();
    // Use client...
}