Skip to content

docs(rust): point dependency examples at the published 1.0 line #2520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveSandersonMS merged 2 commits into from
Sep 4, 2026
+6 −9
Merged

docs(rust): point dependency examples at the published 1.0 line #2520

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3c6aeb
docs(rust): point dependency examples at the published 1.0 line
Sep 4, 2026
72dda4d
docs(rust): use compatible major version requirements
SteveSandersonMS Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,7 +928,7 @@ Enable `bundled-in-process` to additionally embed the native runtime library
and use `Transport::InProcess`:

```toml
github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] }
github-copilot-sdk = { version = "1", features = ["bundled-in-process"] }
```

`CliProgram::Path` and raw `ClientOptions::extra_args` apply only to
Expand All @@ -938,7 +938,7 @@ provisioned compatible runtime package with in-process transport.
For builds that prefer a smaller artifact, disable the `bundled-cli` feature:

```toml
github-copilot-sdk = { version = "0.1", default-features = false }
github-copilot-sdk = { version = "1", default-features = false }
```

> **You become responsible for supplying the runtime at deployment.** With
Expand Down Expand Up @@ -1076,20 +1076,17 @@ Supported: `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`, `win32-x64`
| `derive` | — | `schema_for::<T>()` for generating JSON Schema from Rust types (adds `schemars`). |

```toml
# These examples use registry syntax for illustration; until the crate is
# published, use a path or git dependency instead.

# Default — bundles the Copilot CLI in your binary.
github-copilot-sdk = "0.1"
github-copilot-sdk = "1"

# Enable the in-process transport and bundle its native runtime library.
github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] }
github-copilot-sdk = { version = "1", features = ["bundled-in-process"] }

# Opt out of bundling — supply the CLI explicitly at runtime.
github-copilot-sdk = { version = "0.1", default-features = false }
github-copilot-sdk = { version = "1", default-features = false }

# Derive JSON Schema for tool parameters (adds to default bundled-cli).
github-copilot-sdk = { version = "0.1", features = ["derive"] }
github-copilot-sdk = { version = "1", features = ["derive"] }
```

## Development
Expand Down
Loading