Skip to main content

Module options

Module options 

Source
Expand description

Configuration for spawning a Client.

SDK’s ClaudeAgentOptions.

Re-exports§

use std::path::PathBuf; 🔒
use std::sync::Arc; 🔒
use crate::hooks::Hooks; 🔒
use std::collections::HashMap; 🔒
use crate::mcp::McpServer; 🔒
use crate::permissions::CanUseToolCallback; 🔒
use forge_primitives::subagents::SubagentEffort; 🔒

Structs§

Options
Configuration for one Client invocation.
OptionsBuilder
Builder for Options.

Enums§

PermissionMode
Which permission flow the claude binary should use for tool invocations. Mirrors the upstream CLI’s six-variant set.
SdkPluginConfig
Plugin config. Wraps the CLI’s SdkPluginConfig ({"type": "local", "path": str}).
SystemPromptKind
System-prompt configuration. Wraps the CLI’s discriminated union of str | SystemPromptPreset | SystemPromptFile.

Type Aliases§

AutoApproveToolPredicate
Predicate used by Options::auto_approve_tool to short-circuit the permission flow for trusted tool names (e.g. forge’s own in-process MCP server prefixes).
WireTee
Per-line callback used by Options::tee_inbound and Options::tee_outbound to capture the wire bytes the SDK exchanges with the claude subprocess. The callback receives lines without a trailing newline.