Module com.github.copilot.java

Package com.github.copilot.rpc

Enum Class CopilotClientMode

java.lang.Object

java.lang.Enum<CopilotClientMode>

com.github.copilot.rpc.CopilotClientMode

All Implemented Interfaces:

Serializable, Comparable<CopilotClientMode>, Constable

public enum CopilotClientMode
extends Enum<CopilotClientMode>

Selects the defaulting strategy used by CopilotClient.

Since:

1.3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COPILOT_CLI	Uses defaults equivalent to GitHub Copilot CLI.
EMPTY	Disables optional features by default.

Method Summary

Modifier and Type	Method	Description
static CopilotClientMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CopilotClientMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EMPTY

public static final CopilotClientMode EMPTY

Disables optional features by default. The app must explicitly opt into anything it needs. Required for any scenario where CLI-like ambient behavior is unsafe (e.g., multi-user servers).

When this mode is selected:

• The client constructor requires CopilotClientOptions.getCopilotHome() or CopilotClientOptions.getCliUrl() to be set.
• SessionConfig.getAvailableTools() must be supplied on every session — no tools are exposed by default.
• session.create always sets toolFilterPrecedence: "excluded" so the allowlist and denylist compose naturally.
• The SDK injects safe defaults for ambient session features (telemetry, custom instructions, plugins, environment context, etc.).

COPILOT_CLI

public static final CopilotClientMode COPILOT_CLI

Uses defaults equivalent to GitHub Copilot CLI. The default. Useful when building a coding agent that shares sessions with Copilot CLI.

Do not use this mode for server-based multi-user applications — the default coding agent has tools and capabilities that operate across sessions and can access the host OS environment.

Method Details

values

public static CopilotClientMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CopilotClientMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null