Struct ClientOptions 

pub struct ClientOptions {

    pub cli_path: Option<PathBuf>,
    pub cli_args: Option<Vec<String>>,
    pub cwd: Option<PathBuf>,
    pub port: u16,
    pub use_stdio: bool,
    pub cli_url: Option<String>,
    pub log_level: LogLevel,
    pub auto_start: bool,
    pub auto_restart: bool,
    pub environment: Option<HashMap<String, String>>,
    pub github_token: Option<String>,
    pub use_logged_in_user: Option<bool>,
    pub deny_tools: Option<Vec<String>>,
    pub allow_tools: Option<Vec<String>>,
    pub allow_all_tools: bool,
}

Options for creating a CopilotClient.

Fields

cli_path: Option<PathBuf>

cli_args: Option<Vec<String>>

cwd: Option<PathBuf>

port: u16

use_stdio: bool

cli_url: Option<String>

log_level: LogLevel

auto_start: bool

auto_restart: bool

environment: Option<HashMap<String, String>>

github_token: Option<String>

GitHub personal access token for authentication. Cannot be used together with cli_url.

use_logged_in_user: Option<bool>

Whether to use the logged-in user for auth. Defaults to true when github_token is empty. Cannot be used with cli_url.

deny_tools: Option<Vec<String>>

Tool specifications to deny (passed as --deny-tool arguments to the CLI).

Each entry follows the CLI’s tool specification format:

• "shell(git push)" — deny a specific shell command
• "shell(git)" — deny all git commands
• "shell(rm)" — deny rm commands
• "shell" — deny all shell commands
• "write" — deny file write operations
• "MCP_SERVER(tool_name)" — deny a specific MCP tool

--deny-tool takes precedence over --allow-tool and --allow-all-tools.

allow_tools: Option<Vec<String>>

Tool specifications to allow without manual approval (passed as --allow-tool arguments to the CLI).

Each entry follows the same format as deny_tools.

allow_all_tools: bool

If true, passes --allow-all-tools to the CLI.

This allows Copilot to use any tool without asking for approval. Use deny_tools in combination to create an allowlist with exceptions.

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.