You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Consolidate Go initialism casing
* replace UriConnection for URIConnection
* replace TcpConnection for TCPConnection
* Update docs for Go initialism casing
* Remove Go GitHub casing overrides
@@ -2105,7 +2105,7 @@ var session = client.createSession(
2105
2105
2106
2106
</details>
2107
2107
2108
-
**Note:** When `cli_url` / `cliUrl` / Go's `UriConnection` is provided, or Rust uses `Transport::External`, the SDK will not spawn or manage a CLI process - it will only connect to the existing server at the specified URL.
2108
+
**Note:** When `cli_url` / `cliUrl` / Go's `URIConnection` is provided, or Rust uses `Transport::External`, the SDK will not spawn or manage a CLI process - it will only connect to the existing server at the specified URL.
Copy file name to clipboardExpand all lines: docs/setup/backend-services.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Run the Copilot SDK in server-side applications—APIs, web backends, microservi
6
6
7
7
## How it works
8
8
9
-
Instead of the SDK spawning a CLI child process, you run the CLI independently in **headless server mode**. Your backend connects to it over TCP using the `Connection` option (`UriConnection`).
9
+
Instead of the SDK spawning a CLI child process, you run the CLI independently in **headless server mode**. Your backend connects to it over TCP using the `Connection` option (`URIConnection`).
-`Connection` (RuntimeConnection): How the SDK connects to the runtime. Construct via one of:
138
138
-`StdioConnection{Path, Args}` — spawn a runtime over stdio (the default if `Connection` is nil)
139
-
-`TcpConnection{Port, ConnectionToken, Path, Args}` — spawn a runtime that listens on TCP
140
-
-`UriConnection{URL, ConnectionToken}` — connect to an already-running runtime (no process spawned)
139
+
-`TCPConnection{Port, ConnectionToken, Path, Args}` — spawn a runtime that listens on TCP
140
+
-`URIConnection{URL, ConnectionToken}` — connect to an already-running runtime (no process spawned)
141
141
142
142
When `Path` is empty for stdio/tcp, the SDK uses the bundled CLI (or `COPILOT_CLI_PATH` env var).
143
143
-`WorkingDirectory` (string): Working directory for the runtime process
144
-
-`BaseDirectory` (string): Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime. When empty, the runtime defaults to `~/.copilot`. Ignored with `UriConnection`. This does **not** affect where the Go SDK extracts the embedded CLI binary; use `embeddedcli.Config.Dir` for the extraction/cache location.
144
+
-`BaseDirectory` (string): Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime. When empty, the runtime defaults to `~/.copilot`. Ignored with `URIConnection`. This does **not** affect where the Go SDK extracts the embedded CLI binary; use `embeddedcli.Config.Dir` for the extraction/cache location.
145
145
-`LogLevel` (string): Log level. When empty (default), the runtime uses its own default level (the SDK does not pass `--log-level`).
146
146
-`Env` ([]string): Environment variables for the runtime process (default: inherits from current process)
147
147
-`GitHubToken` (string): GitHub token for authentication. When provided, takes priority over other auth methods.
148
-
-`UseLoggedInUser` (\*bool): Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `UriConnection`.
149
-
-`EnableRemoteSessions` (bool): Enable remote session support (Mission Control integration). Ignored with `UriConnection`.
148
+
-`UseLoggedInUser` (\*bool): Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `URIConnection`.
149
+
-`EnableRemoteSessions` (bool): Enable remote session support (Mission Control integration). Ignored with `URIConnection`.
150
150
-`Telemetry` (\*TelemetryConfig): OpenTelemetry configuration for the runtime. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.
151
151
152
152
**SessionConfig:**
@@ -495,7 +495,7 @@ The SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own K
495
495
-`BaseURL` (string): API endpoint URL (required)
496
496
-`APIKey` (string): API key (optional for local providers like Ollama)
497
497
-`BearerToken` (string): Bearer token for authentication (takes precedence over APIKey)
498
-
-`WireApi` (string): API format for OpenAI/Azure - "completions" or "responses" (default: "completions")
498
+
-`WireAPI` (string): API format for OpenAI/Azure - "completions" or "responses" (default: "completions")
499
499
-`Azure.APIVersion` (string): Azure API version (default: "2024-10-21")
0 commit comments