createCopilotHarness

Purpose and behavior

Create the GitHub Copilot CLI preset without starting the CLI; createAgent({ harness, model }) binds it and rejects reasoning and maxOutputTokens. It captures and resumes session bundles, is steered by stopping and resuming the turn, and rejects fork. Usage is reported per message, then as a session total read after exit.

Complete example and detailed rules.

Parameters and properties

• settingsOptional
  CopilotSettings | undefined
  GitHub Copilot CLI settings; model, reasoning and maxOutputTokens belong on createAgent() and are rejected here.
• settings.authenticationOptional
  AgentAuthentication | undefined
  Account forms only: “account” forwards the token that copilot login stored in ~/.copilot/config.json as COPILOT_GITHUB_TOKEN, key or variable forward a fine-grained token. Usage forms fail when the agent is composed, and classic ghp_ tokens are rejected.
• settings.variablesOptional
  Readonly<Record<string, string>> | undefined
  Environment variables for Copilot commands, merged over .outpost/.env; COPILOT_AUTO_UPDATE defaults to false. A name also set by the sandbox provider fails with code configuration.
• settings.conversationsOptional
  ConversationStore | undefined
  Store that captures, locates and restores Copilot session bundles instead of the default native store, such as createTransportConversations(createCopilotConversations(), …). A store that declares another format is rejected when the harness is created.
• settings.mcpServersOptional
  McpServers | undefined
  MCP servers passed to Copilot with —additional-mcp-config for each run, keyed by server name. Secrets stay ${NAME} references expanded by Copilot; each referenced variable must be declared.

Returns

CliHarness

Signature

export declare function createCopilotHarness(
  settings?: CopilotSettings,
): CliHarness;

Related contracts

• CliHarness
• CopilotSettings