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
Clientinvocation. - Options
Builder - Builder for
Options.
Enums§
- Permission
Mode - Which permission flow the
claudebinary should use for tool invocations. Mirrors the upstream CLI’s six-variant set. - SdkPlugin
Config - Plugin config. Wraps the CLI’s
SdkPluginConfig({"type": "local", "path": str}). - System
Prompt Kind - System-prompt configuration. Wraps the CLI’s discriminated union of
str | SystemPromptPreset | SystemPromptFile.
Type Aliases§
- Auto
Approve Tool Predicate - Predicate used by
Options::auto_approve_toolto 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_inboundandOptions::tee_outboundto capture the wire bytes the SDK exchanges with theclaudesubprocess. The callback receives lines without a trailing newline.