Interface CopilotClientOptions

The client options this integration sets.

interface CopilotClientOptions {
    baseDirectory?: string;
    connection?: StdioRuntimeConnection;
    env?: Record<string, undefined | string>;
    gitHubToken?: string;
    logLevel?: "error" | "none" | "warning" | "info" | "debug" | "all";
    mode?: CopilotClientMode;
    useLoggedInUser?: boolean;
}

Index

Properties

baseDirectory? connection? env? gitHubToken? logLevel? mode? useLoggedInUser?

Properties

`Optional`baseDirectory

baseDirectory?: string

Copilot home of the runtime, which becomes its COPILOT_HOME. Required in empty mode.

`Optional`connection

connection?: StdioRuntimeConnection

`Optional`env

env?: Record<string, undefined | string>

`Optional`gitHubToken

gitHubToken?: string

`Optional`logLevel

logLevel?: "error" | "none" | "warning" | "info" | "debug" | "all"

`Optional`mode

mode?: CopilotClientMode

`Optional`useLoggedInUser

useLoggedInUser?: boolean

When false, only an explicit token is used and no sign-in found on the host.