From 55cd32fa4c5b55976cddeeabf9a5e4d2b0e64ff5 Mon Sep 17 00:00:00 2001
From: examon <examon@users.noreply.github.com>
Date: Thu, 30 Jul 2026 23:37:38 +0000
Subject: [PATCH] docs: correct the remote sessions client option name

The remote sessions guide told users to enable Mission Control remote
sessions with a client option named `remote` (TypeScript) / `Remote`
(Go, C#). No such option exists. It was renamed to
`enableRemoteSessions` / `EnableRemoteSessions` during the per-language
API reviews (#1343, #1357, #1360), none of which updated this guide. The
Rust (#1367) and Python (#1376) reviews did update their own tabs, which
is why those two were already correct.

As a result, the documented client construction does not compile in
TypeScript, Go or C#.

- Correct the option name in the section lead-in and in the TypeScript,
  Go and C# examples.
- Fix the Go example's return arity on the same line: NewClient returns
  a single value.
- Correct the Notes bullet, which named the same nonexistent option and
  also said the option applies only when the SDK spawns the CLI process.
  It is honored on both the child-process and in-process host paths.
---
 docs/features/remote-sessions.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/features/remote-sessions.md b/docs/features/remote-sessions.md
index 5a15ca825..f103b9cf6 100644
--- a/docs/features/remote-sessions.md
+++ b/docs/features/remote-sessions.md
@@ -13,7 +13,7 @@ For running sessions on GitHub-hosted compute, see [Cloud Sessions](./cloud-sess
 
 ### Always-on (client-level)
 
-Set `remote: true` when creating the client. Every session in a GitHub repo automatically gets a remote URL.
+Set `enableRemoteSessions: true` when creating the client. Every session in a GitHub repo automatically gets a remote URL.
 
 <!-- tabs:start -->
 
@@ -23,7 +23,7 @@ Set `remote: true` when creating the client. Every session in a GitHub repo auto
 ```typescript
 import { CopilotClient } from "@github/copilot-sdk";
 
-const client = new CopilotClient({ remote: true });
+const client = new CopilotClient({ enableRemoteSessions: true });
 const session = await client.createSession({
   workingDirectory: "/path/to/github-repo",
   onPermissionRequest: async () => ({ allowed: true }),
@@ -59,7 +59,7 @@ session.on(on_event)
 
 <!-- docs-validate: skip -->
 ```go
-client, _ := copilot.NewClient(&copilot.ClientOptions{Remote: true})
+client := copilot.NewClient(&copilot.ClientOptions{EnableRemoteSessions: true})
 session, _ := client.CreateSession(ctx, &copilot.SessionConfig{
     WorkingDirectory: "/path/to/github-repo",
     OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) {
@@ -78,7 +78,7 @@ session.On(func(event copilot.SessionEvent) {
 
 <!-- docs-validate: skip -->
 ```csharp
-var client = new CopilotClient(new CopilotClientOptions { Remote = true });
+var client = new CopilotClient(new CopilotClientOptions { EnableRemoteSessions = true });
 var session = await client.CreateSessionAsync(new SessionConfig
 {
     WorkingDirectory = "/path/to/github-repo",
@@ -201,6 +201,6 @@ The remote URL can be rendered as a QR code for easy mobile access. The SDK prov
 
 ## Notes
 
-* The `remote` client option only applies when the SDK spawns the CLI process. It is ignored when connecting to an external server via `cliUrl`.
+* The `enableRemoteSessions` client option applies when the SDK starts the runtime, either as a child process or as an in-process host. It is ignored when connecting to an already-running runtime.
 * If the working directory is not a GitHub repository, remote setup is silently skipped (always-on mode) or returns an error (on-demand mode).
 * Remote sessions require authentication. Ensure `gitHubToken` or `useLoggedInUser` is configured.