Package com.github.copilot

package com.github.copilot

Core classes for the GitHub Copilot SDK for Java.

This package provides the main entry points for interacting with GitHub Copilot programmatically. The SDK enables Java applications to leverage Copilot's agentic capabilities, including multi-turn conversations, tool execution, and AI-powered code generation.

Main Classes

• CopilotClient - The main client for connecting to and communicating with the Copilot CLI. Manages the lifecycle of the CLI process and provides methods for creating sessions, querying models, and checking authentication status.
• CopilotSession - Represents a single conversation session with Copilot. Sessions maintain context across multiple messages and support streaming responses, tool invocations, and event handling.
• JsonRpcClient - Low-level JSON-RPC client for communication with the Copilot CLI process.

Quick Start

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

	var session = client.createSession(new SessionConfig().setModel("gpt-4.1")).get();

	session.on(AssistantMessageEvent.class, msg -> {
		System.out.println(msg.getData().content());
	});

	session.send(new MessageOptions().setPrompt("Hello, Copilot!")).get();
}

Related Packages

• com.github.copilot.generated - Auto-generated event types emitted during session processing
• com.github.copilot.rpc - Configuration and data transfer objects

See Also:

• CopilotClient
• CopilotSession
• GitHub Repository

Related Packages

Package	Description
com.github.copilot.generated	Auto-generated session event types for the GitHub Copilot SDK.
com.github.copilot.rpc	Configuration classes and data transfer objects for the Copilot SDK.
com.github.copilot.tool

Class	Description
AllowCopilotExperimental	Opts a declaration into using CopilotExperimental APIs.
ConnectionState	Represents the connection state of a CopilotClient.
CopilotClient	Provides a client for interacting with the Copilot CLI server.
CopilotExperimental	Marks a type or method as experimental.
CopilotExperimentalProcessor	Annotation processor that enforces compile-time gating of experimental APIs.
CopilotRequestContext	The per-request context handed to every CopilotRequestHandler hook.
CopilotRequestHandler	The base class for SDK consumers who want to observe or replace the LLM inference requests the runtime issues (for both CAPI and BYOK providers).
CopilotRequestTransport	The transport the runtime would otherwise use to issue an intercepted model-layer request.
CopilotSession	Represents a single conversation session with the Copilot CLI.
CopilotWebSocketCloseStatus	The terminal status for a callback-owned WebSocket connection.
CopilotWebSocketForwarder	The default pass-through CopilotWebSocketHandler: it dials the real upstream using WebSocket and relays upstream-to-runtime messages into the runtime response unchanged.
CopilotWebSocketHandler	A per-connection WebSocket handler returned by CopilotRequestHandler.openWebSocket(CopilotRequestContext).
CopilotWebSocketMessage	A single WebSocket message exchanged through a CopilotWebSocketHandler hook.
EventErrorHandler	A handler for errors thrown by event handlers during event dispatch.
EventErrorPolicy	Controls how event dispatch behaves when an event handler throws an exception.
SdkProtocolVersion	Provides the SDK protocol version.
SystemMessageMode	Specifies how the system message should be applied to a session.