Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for creating a Copilot client.

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new builder.

pub fn cli_path(self, path: impl Into<PathBuf>) -> Self

Set the CLI executable path.

pub fn cli_args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set additional CLI arguments passed to the Copilot CLI.

pub fn cli_arg(self, arg: impl Into<String>) -> Self

Add a single CLI argument passed to the Copilot CLI.

pub fn use_stdio(self, use_stdio: bool) -> Self

Use stdio mode (default).

pub fn cli_url(self, url: impl Into<String>) -> Self

Set the CLI URL for TCP mode.

Supports: "host:port", "http://host:port", or "port" (defaults to localhost).

pub fn port(self, port: u16) -> Self

Set port for TCP mode (ignored for stdio mode).

Use 0 to let the CLI choose a random available port.

pub fn auto_start(self, auto_start: bool) -> Self

Auto-start the connection on first use.

pub fn auto_restart(self, auto_restart: bool) -> Self

Auto-restart the connection after a fatal failure.

pub fn log_level(self, level: LogLevel) -> Self

Set the log level.

pub fn cwd(self, dir: impl Into<PathBuf>) -> Self

Set the working directory.

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add an environment variable.

pub fn github_token(self, token: impl Into<String>) -> Self

Set a GitHub personal access token for authentication.

pub fn use_logged_in_user(self, value: bool) -> Self

Set whether to use the logged-in user for auth.

pub fn deny_tool(self, tool_spec: impl Into<String>) -> Self

Add a single tool specification to deny.

Passed as --deny-tool to the CLI. Takes precedence over allow options.

Example

use copilot_sdk::Client;

let client = Client::builder()
    .deny_tool("shell(git push)")
    .deny_tool("shell(git commit)")
    .deny_tool("shell(rm)")
    .build()?;

pub fn deny_tools<I, S>(self, tool_specs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set multiple tool specifications to deny.

Passed as --deny-tool arguments to the CLI.

pub fn allow_tool(self, tool_spec: impl Into<String>) -> Self

Add a single tool specification to allow without manual approval.

Passed as --allow-tool to the CLI.

pub fn allow_tools<I, S>(self, tool_specs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set multiple tool specifications to allow without manual approval.

Passed as --allow-tool arguments to the CLI.

pub fn allow_all_tools(self, allow: bool) -> Self

Allow all tools without manual approval.

Passes --allow-all-tools to the CLI. Use with deny_tool() to create an allowlist with specific exceptions.

Example

use copilot_sdk::Client;

// Allow everything except dangerous git operations and rm
let client = Client::builder()
    .allow_all_tools(true)
    .deny_tool("shell(git push)")
    .deny_tool("shell(git commit)")
    .deny_tool("shell(rm)")
    .build()?;

pub fn build(self) -> Result<Client>

Build the client.

Trait Implementations

impl Debug for ClientBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.