@github/copilot-sdk 0.1.24 → 0.1.25-preview.0

package/README.md

@@ -10,6 +10,19 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.
 npm install @github/copilot-sdk
 ```
 
+## Run the Sample
+
+Try the interactive chat sample (from the repo root):
+
+```bash
+cd nodejs
+npm ci
+npm run build
+cd samples
+npm install
+npm start
+```
+
 ## Quick Start
 
 ```typescript

package/dist/client.d.ts

@@ -9,6 +9,7 @@ export declare class CopilotClient {
     private actualHost;
     private state;
     private sessions;
+    private stderrBuffer;
     private options;
     private isExternalServer;
     private forceStopping;
@@ -17,6 +18,7 @@ export declare class CopilotClient {
     private sessionLifecycleHandlers;
     private typedLifecycleHandlers;
     private _rpc;
+    private processExitPromise;
     /**
      * Typed server-scoped RPC methods.
      * @throws Error if the client is not connected

package/dist/client.js

@@ -34,6 +34,8 @@ class CopilotClient {
   actualHost = "localhost";
   state = "disconnected";
   sessions = /* @__PURE__ */ new Map();
+  stderrBuffer = "";
+  // Captures CLI stderr for error messages
   options;
   isExternalServer = false;
   forceStopping = false;
@@ -42,6 +44,8 @@ class CopilotClient {
   sessionLifecycleHandlers = /* @__PURE__ */ new Set();
   typedLifecycleHandlers = /* @__PURE__ */ new Map();
   _rpc = null;
+  processExitPromise = null;
+  // Rejects when CLI process exits
   /**
    * Typed server-scoped RPC methods.
    * @throws Error if the client is not connected
@@ -251,6 +255,8 @@ class CopilotClient {
     }
     this.state = "disconnected";
     this.actualPort = null;
+    this.stderrBuffer = "";
+    this.processExitPromise = null;
     return errors;
   }
   /**
@@ -306,6 +312,8 @@ class CopilotClient {
     }
     this.state = "disconnected";
     this.actualPort = null;
+    this.stderrBuffer = "";
+    this.processExitPromise = null;
   }
   /**
    * Creates a new conversation session with the Copilot CLI.
@@ -362,6 +370,7 @@ class CopilotClient {
       workingDirectory: config.workingDirectory,
       streaming: config.streaming,
       mcpServers: config.mcpServers,
+      envValueMode: "direct",
       customAgents: config.customAgents,
       configDir: config.configDir,
       skillDirectories: config.skillDirectories,
@@ -434,6 +443,7 @@ class CopilotClient {
       configDir: config.configDir,
       streaming: config.streaming,
       mcpServers: config.mcpServers,
+      envValueMode: "direct",
       customAgents: config.customAgents,
       skillDirectories: config.skillDirectories,
       disabledSkills: config.disabledSkills,
@@ -545,7 +555,12 @@ class CopilotClient {
    */
   async verifyProtocolVersion() {
     const expectedVersion = getSdkProtocolVersion();
-    const pingResult = await this.ping();
+    let pingResult;
+    if (this.processExitPromise) {
+      pingResult = await Promise.race([this.ping(), this.processExitPromise]);
+    } else {
+      pingResult = await this.ping();
+    }
     const serverVersion = pingResult.protocolVersion;
     if (serverVersion === void 0) {
       throw new Error(
@@ -714,6 +729,7 @@ class CopilotClient {
    */
   async startCLIServer() {
     return new Promise((resolve, reject) => {
+      this.stderrBuffer = "";
       const args = [
         ...this.options.cliArgs,
         "--headless",
@@ -776,6 +792,7 @@ class CopilotClient {
         });
       }
       this.cliProcess.stderr?.on("data", (data) => {
+        this.stderrBuffer += data.toString();
         const lines = data.toString().split("\n");
         for (const line of lines) {
           if (line.trim()) {
@@ -787,13 +804,54 @@ class CopilotClient {
       this.cliProcess.on("error", (error) => {
         if (!resolved) {
           resolved = true;
-          reject(new Error(`Failed to start CLI server: ${error.message}`));
+          const stderrOutput = this.stderrBuffer.trim();
+          if (stderrOutput) {
+            reject(
+              new Error(
+                `Failed to start CLI server: ${error.message}
+stderr: ${stderrOutput}`
+              )
+            );
+          } else {
+            reject(new Error(`Failed to start CLI server: ${error.message}`));
+          }
         }
       });
+      this.processExitPromise = new Promise((_, rejectProcessExit) => {
+        this.cliProcess.on("exit", (code) => {
+          setTimeout(() => {
+            const stderrOutput = this.stderrBuffer.trim();
+            if (stderrOutput) {
+              rejectProcessExit(
+                new Error(
+                  `CLI server exited with code ${code}
+stderr: ${stderrOutput}`
+                )
+              );
+            } else {
+              rejectProcessExit(
+                new Error(`CLI server exited unexpectedly with code ${code}`)
+              );
+            }
+          }, 50);
+        });
+      });
+      this.processExitPromise.catch(() => {
+      });
       this.cliProcess.on("exit", (code) => {
         if (!resolved) {
           resolved = true;
-          reject(new Error(`CLI server exited with code ${code}`));
+          const stderrOutput = this.stderrBuffer.trim();
+          if (stderrOutput) {
+            reject(
+              new Error(
+                `CLI server exited with code ${code}
+stderr: ${stderrOutput}`
+              )
+            );
+          } else {
+            reject(new Error(`CLI server exited with code ${code}`));
+          }
         } else if (this.options.autoRestart && this.state === "connected") {
           void this.reconnect();
         }

package/dist/generated/rpc.d.ts

@@ -163,6 +163,130 @@ export interface SessionModelSwitchToParams {
     sessionId: string;
     modelId: string;
 }
+export interface SessionModeGetResult {
+    /**
+     * The current agent mode.
+     */
+    mode: "interactive" | "plan" | "autopilot";
+}
+export interface SessionModeGetParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+}
+export interface SessionModeSetResult {
+    /**
+     * The agent mode after switching.
+     */
+    mode: "interactive" | "plan" | "autopilot";
+}
+export interface SessionModeSetParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+    /**
+     * The mode to switch to. Valid values: "interactive", "plan", "autopilot".
+     */
+    mode: "interactive" | "plan" | "autopilot";
+}
+export interface SessionPlanReadResult {
+    /**
+     * Whether plan.md exists in the workspace
+     */
+    exists: boolean;
+    /**
+     * The content of plan.md, or null if it does not exist
+     */
+    content: string | null;
+}
+export interface SessionPlanReadParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+}
+export interface SessionPlanUpdateResult {
+}
+export interface SessionPlanUpdateParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+    /**
+     * The new content for plan.md
+     */
+    content: string;
+}
+export interface SessionPlanDeleteResult {
+}
+export interface SessionPlanDeleteParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+}
+export interface SessionWorkspaceListFilesResult {
+    /**
+     * Relative file paths in the workspace files directory
+     */
+    files: string[];
+}
+export interface SessionWorkspaceListFilesParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+}
+export interface SessionWorkspaceReadFileResult {
+    /**
+     * File content as a UTF-8 string
+     */
+    content: string;
+}
+export interface SessionWorkspaceReadFileParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+    /**
+     * Relative path within the workspace files directory
+     */
+    path: string;
+}
+export interface SessionWorkspaceCreateFileResult {
+}
+export interface SessionWorkspaceCreateFileParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+    /**
+     * Relative path within the workspace files directory
+     */
+    path: string;
+    /**
+     * File content to write as a UTF-8 string
+     */
+    content: string;
+}
+export interface SessionFleetStartResult {
+    /**
+     * Whether fleet mode was successfully activated
+     */
+    started: boolean;
+}
+export interface SessionFleetStartParams {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+    /**
+     * Optional user prompt to combine with fleet instructions
+     */
+    prompt?: string;
+}
 /** Create typed server-scoped RPC methods (no session required). */
 export declare function createServerRpc(connection: MessageConnection): {
     ping: (params: PingParams) => Promise<PingResult>;
@@ -182,4 +306,21 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
         getCurrent: () => Promise<SessionModelGetCurrentResult>;
         switchTo: (params: Omit<SessionModelSwitchToParams, "sessionId">) => Promise<SessionModelSwitchToResult>;
     };
+    mode: {
+        get: () => Promise<SessionModeGetResult>;
+        set: (params: Omit<SessionModeSetParams, "sessionId">) => Promise<SessionModeSetResult>;
+    };
+    plan: {
+        read: () => Promise<SessionPlanReadResult>;
+        update: (params: Omit<SessionPlanUpdateParams, "sessionId">) => Promise<SessionPlanUpdateResult>;
+        delete: () => Promise<SessionPlanDeleteResult>;
+    };
+    workspace: {
+        listFiles: () => Promise<SessionWorkspaceListFilesResult>;
+        readFile: (params: Omit<SessionWorkspaceReadFileParams, "sessionId">) => Promise<SessionWorkspaceReadFileResult>;
+        createFile: (params: Omit<SessionWorkspaceCreateFileParams, "sessionId">) => Promise<SessionWorkspaceCreateFileResult>;
+    };
+    fleet: {
+        start: (params: Omit<SessionFleetStartParams, "sessionId">) => Promise<SessionFleetStartResult>;
+    };
 };

package/dist/generated/rpc.js

@@ -17,6 +17,23 @@ function createSessionRpc(connection, sessionId) {
     model: {
       getCurrent: async () => connection.sendRequest("session.model.getCurrent", { sessionId }),
       switchTo: async (params) => connection.sendRequest("session.model.switchTo", { sessionId, ...params })
+    },
+    mode: {
+      get: async () => connection.sendRequest("session.mode.get", { sessionId }),
+      set: async (params) => connection.sendRequest("session.mode.set", { sessionId, ...params })
+    },
+    plan: {
+      read: async () => connection.sendRequest("session.plan.read", { sessionId }),
+      update: async (params) => connection.sendRequest("session.plan.update", { sessionId, ...params }),
+      delete: async () => connection.sendRequest("session.plan.delete", { sessionId })
+    },
+    workspace: {
+      listFiles: async () => connection.sendRequest("session.workspace.listFiles", { sessionId }),
+      readFile: async (params) => connection.sendRequest("session.workspace.readFile", { sessionId, ...params }),
+      createFile: async (params) => connection.sendRequest("session.workspace.createFile", { sessionId, ...params })
+    },
+    fleet: {
+      start: async (params) => connection.sendRequest("session.fleet.start", { sessionId, ...params })
     }
   };
 }

package/dist/generated/session-events.d.ts

@@ -97,6 +97,38 @@ export type SessionEvent = {
         previousModel?: string;
         newModel: string;
     };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.mode_changed";
+    data: {
+        previousMode: string;
+        newMode: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.plan_changed";
+    data: {
+        operation: "create" | "update" | "delete";
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.workspace_file_changed";
+    data: {
+        /**
+         * Relative path within the workspace files directory
+         */
+        path: string;
+        operation: "create" | "update";
+    };
 } | {
     id: string;
     timestamp: string;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "0.1.24",
+  "version": "0.1.25-preview.0",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@github/copilot": "^0.0.409",
+    "@github/copilot": "^0.0.411-1",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },