Struct CliAgentBuilder 

pub struct CliAgentBuilder { /* private fields */ }

Default AgentCore assembly builder for the defect CLI.

Implementations

impl CliAgentBuilder

pub fn new( cwd: PathBuf, load_options: LoadConfigOptions, config: LoadedConfig, ) -> Self

Creates a CLI agent builder with the full default feature set.

pub fn features(self, features: DefaultFeatureSet) -> Self

Replace the default feature set.

pub fn repl(self, repl: ReplMode) -> Self

Enable REPL assembly semantics.

pub fn local_sessions(self) -> Self

Use the project-local session directory.

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

Set the top-level profile.

pub fn resume(self, session_id: Option<String>) -> Self

Set the resume parameter. None means bare --resume, which looks up the most recent session by cwd.

pub fn provider_registry(self, registry: Arc<ProviderRegistry>) -> Self

Overrides the provider registry directly.

pub fn add_provider_entry(self, entry: ProviderEntry) -> Self

Appends a provider entry after the default provider entries.

pub fn process_tools(self, tools: Arc<dyn ToolRegistry>) -> Self

Overrides the process-level tool registry directly.

pub fn add_tool(self, tool: Arc<dyn Tool>) -> Self

Adds a tool on top of the default process-level tools. When names conflict, the added tool takes precedence.

pub fn add_tool_registry(self, registry: Arc<dyn ToolRegistry>) -> Self

Overlay a registry onto the default process-level tools. Registries added later take higher priority.

pub fn policy(self, policy: Arc<dyn SandboxPolicy>) -> Self

Overrides the sandbox policy.

pub fn non_interactive(self) -> Self

Wraps the final policy with NonInteractivePolicy: downgrades inner Ask to Deny to prevent hanging on permission prompts in non‑TTY environments (--message single‑turn mode). Allow / Deny pass through unchanged.

pub fn goal(self, objective: impl Into<String>) -> Self

Enable the --goal goal-driven loop: registers the goal_done tool, installs a goal-gate hook (before_turn_end), and attaches GoalState to the session. The agent runs autonomously for multiple turns until goal_done is called (success) or the max_hook_continues limit (--max-turns) is reached.

pub fn max_turns(self, max_turns: u32) -> Self

--max-turns: the maximum number of times before_turn_end can extend the session in goal mode (mapped to TurnConfig::max_hook_continues). When the limit is reached, the session is forcibly stopped and exits with Exhausted.

pub fn modes(self, modes: ModeCatalog) -> Self

Override the permission mode catalog.

pub fn hook_engine(self, hook_engine: Arc<dyn HookEngine>) -> Self

Override the hook engine.

pub fn builtin_registry(self, registry: BuiltinRegistry) -> Self

Registers a builtin hook factory.

pub fn session_tool_factory(self, factory: Arc<dyn SessionToolFactory>) -> Self

Override the session-level tool factory, e.g. for custom MCP integration.

pub fn observe_session(self, observer: Arc<dyn SessionObserver>) -> Self

Adds a session observer. The observer can subscribe to the event stream after session creation and push events to an external system.

pub async fn build(self) -> Result<BuiltCliAgent>

Builds an AgentCore along with CLI companion information.

Errors

Returns an error if configuration derivation fails, provider/hook/subagent tool assembly fails, the persistence directory cannot be resolved, or an explicit resume is requested but the target session is not found.