@github/copilot/copilot-sdk/extension.d.ts

GitHub Copilot CLI brings the power of Copilot coding agent directly to your terminal.

import type { CopilotSession } from "./session.js";
import { type ExtensionInfo, type PermissionHandler, type ResumeSessionConfig } from "./types.js";
export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasActionContext, type CanvasDeclaration, type CanvasHostContext, type CanvasJsonSchema, type CanvasLifecycleContext, type CanvasOpenContext, type CanvasOpenResponse, type CanvasOptions, } from "./canvas.js";
export type JoinSessionConfig = Omit<ResumeSessionConfig, "onPermissionRequest"> & {
    onPermissionRequest?: PermissionHandler;
};
export type { ExtensionInfo };
/**
 * Joins the current foreground session.
 *
 * @param config - Configuration to add to the session
 * @returns A promise that resolves with the joined session
 *
 * @example
 * ```typescript
 * import { joinSession } from "@github/copilot-sdk/extension";
 *
 * const session = await joinSession({ tools: [myTool] });
 * ```
 */
export declare function joinSession(config?: JoinSessionConfig): Promise<CopilotSession>;