Skip to content

Commit 7156088

Browse files
Fix Rust transport documentation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: da0a9335-969e-4a77-838a-daac9206a454
1 parent 20ebc53 commit 7156088

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

rust/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ client.stop().await?;
7272

7373
**`ClientOptions`:**
7474

75-
| Field | Type | Description |
76-
| ------------- | --------------------------- | --------------------------------------------------------------- |
77-
| `program` | `CliProgram` | `Resolve` (default: auto-detect) or `Path(PathBuf)` (explicit) |
78-
| `prefix_args` | `Vec<OsString>` | Args before `--server` (e.g. script path for node) |
79-
| `cwd` | `PathBuf` | Working directory for CLI process |
80-
| `env` | `Vec<(OsString, OsString)>` | Deprecated; use the child-process transport's `env` option |
81-
| `env_remove` | `Vec<OsString>` | Deprecated; omit variables from the transport replacement env |
82-
| `extra_args` | `Vec<String>` | Extra CLI flags |
83-
| `transport` | `Transport` | `Stdio`, `InProcess`, `Tcp`, or `External` |
75+
| Field | Type | Description |
76+
| ------------------- | --------------------------- | ----------------------------------------------------------------- |
77+
| `program` | `CliProgram` | `Resolve` (default: auto-detect) or `Path(PathBuf)` (explicit) |
78+
| `prefix_args` | `Vec<OsString>` | Args before `--server` (e.g. script path for node) |
79+
| `working_directory` | `Option<PathBuf>` | Working directory for CLI process |
80+
| `env` | `Vec<(OsString, OsString)>` | Deprecated; use the child-process transport's `env` option |
81+
| `env_remove` | `Vec<OsString>` | Deprecated; omit variables from the transport replacement env |
82+
| `extra_args` | `Vec<String>` | Extra CLI flags |
83+
| `transport` | `Transport` | `Default`, `Stdio`, `InProcess`, `Tcp`, or `External` |
8484

8585
With the default `CliProgram::Resolve`, `Client::start()` resolves the CLI in this order: an explicit `CliProgram::Path(path)`, the `COPILOT_CLI_PATH` env var, then the bundled CLI that was embedded at build time. There is no PATH scanning — if you've opted out of bundling (`default-features = false`) you must supply either `CliProgram::Path` or `COPILOT_CLI_PATH`.
8686

rust/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ pub enum Transport {
130130
///
131131
/// Loads the native runtime library next to the resolved CLI entrypoint
132132
/// and speaks JSON-RPC over its C ABI. The runtime spawns its
133-
/// own worker; the SDK never launches a CLI child process. This is the
134-
/// **Experimental.** Per-client [`ClientOptions::working_directory`],
133+
/// own worker; the SDK never launches a CLI child process. This is
134+
/// **experimental**. Per-client [`ClientOptions::working_directory`],
135135
/// [`ClientOptions::env`]/[`ClientOptions::env_remove`],
136136
/// [`ClientOptions::telemetry`], and [`ClientOptions::github_token`] are
137137
/// not supported because native runtime code shares the host process.

0 commit comments

Comments
 (0)