docs: correct the remote sessions client option name - #2179
Merged
Conversation
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.
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects remote-session client option names and Go client construction in the documentation.
Changes:
- Updates TypeScript, Go, and C# option names.
- Corrects Go’s
NewClientreturn arity. - Clarifies runtime connection behavior.
Show a summary per file
| File | Description |
|---|---|
docs/features/remote-sessions.md |
Corrects remote-session setup examples and notes. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
stephentoub
approved these changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2178
What was wrong
docs/features/remote-sessions.mddocumented a client option namedremote(TypeScript) /Remote(Go, C#) for enabling Mission Control remote sessions. No such option exists. It was renamed toenableRemoteSessions/EnableRemoteSessionsfor cross-SDK consistency during the per-language API reviews (C# in #1343, TypeScript in #1357, Go in #1360), and none of those updated this guide. The Rust (#1367) and Python (#1376) reviews updated their own tabs in it, which is why 2 of the 5 language tabs were already correct and 3 were not.Because every fenced block in this file carries
<!-- docs-validate: skip -->, the documentation validation never compiled these snippets.What this changes
Five lines in one file:
NewClientreturns a single value, soclient, _ := copilot.NewClient(...)was a second, independent compile error.go buildreports both errors together, so fixing only the option name would have left that example broken.## Notesbullet named the same nonexistent option and also claimed the option "only applies when the SDK spawns the CLI process". The option is honored on both the child-process path and the in-process host path, and is ignored only when connecting to an already-running runtime, so the bullet is corrected rather than merely renamed.The Python and Rust tabs are untouched; they were already correct.
Verification
Each corrected client-construction expression was extracted verbatim from the edited file and compiled against a local build of the affected binding, together with the pre-fix expression as a negative control:
TS2353 ... 'remote' does not exist in type 'CopilotClientOptions'tsc --noEmitexit 0assignment mismatch: 2 variables but copilot.NewClient returns 1 valueandunknown field Remote in struct literal of type copilot.ClientOptionsgo buildexit 0CS0117: 'CopilotClientOptions' does not contain a definition for 'Remote'dotnet buildsucceededThe TypeScript case was additionally reproduced against the published
@github/copilot-sdk@1.0.8.The corrected
## Noteswording is pinned by the shipped sources: the option is turned into the same runtime flag on the child-process path and on the in-process host path in all five bindings, and it has no effect on any other path.Not included
## Notesbullet had. They are left for a separate change.docs/features/cloud-sessions.mdalso refers to the old option name.