Struct TuiRunner 

pub struct TuiRunner { /* private fields */ }

TUI configuration that extends AgentCore with TUI-specific settings.

This struct holds all TUI-related configuration that would otherwise need to be stored on AgentCore. Use TuiRunner::new() to create one from an AgentCore, configure it, then call run().

Implementations

impl TuiRunner

pub fn new(agent: AgentCore) -> TuiRunner

Create a new TuiRunner from an AgentCore.

pub fn agent_mut(&mut self) -> &mut AgentCore

Get a mutable reference to the underlying AgentCore.

pub fn agent(&self) -> &AgentCore

Get a reference to the underlying AgentCore.

pub fn set_conversation_factory<F>(&mut self, factory: F) -> &mut TuiRunner

where F: Fn() -> Box<dyn ConversationView> + Send + Sync + 'static,

Set the conversation view factory.

The factory is called to create conversation views when sessions are created or cleared. This allows customizing the chat view with custom welcome screens, title renderers, etc.

pub fn set_layout(&mut self, template: LayoutTemplate) -> &mut TuiRunner

Set the layout template for the TUI.

This allows customizing how widgets are arranged in the terminal. If not set, the default Standard layout with panels is used.

pub fn set_key_handler<H>(&mut self, handler: H) -> &mut TuiRunner

where H: KeyHandler,

Set a custom key handler for the TUI.

This allows full control over key handling behavior.

pub fn set_key_bindings(&mut self, bindings: KeyBindings) -> &mut TuiRunner

Set custom key bindings using the default handler.

This is a simpler alternative to set_key_handler when you only need to change which keys trigger which actions.

pub fn set_exit_handler<H>(&mut self, handler: H) -> &mut TuiRunner

where H: ExitHandler,

Set an exit handler for cleanup before quitting.

The exit handler’s on_exit() method is called when the user confirms exit. If it returns false, the exit is cancelled.

pub fn set_commands( &mut self, commands: Vec<Box<dyn SlashCommand>>, ) -> &mut TuiRunner

Set the slash commands for this agent.

If not called, uses the default command set.

pub fn set_command_extension<T>(&mut self, ext: T) -> &mut TuiRunner

where T: Any + Send + 'static,

Set extension data available to custom commands.

Commands can access this via ctx.extension::<T>().

pub fn register_widget<W>(&mut self, widget: W) -> &mut TuiRunner

where W: Widget,

Register a widget with the agent.

Widgets are registered before calling run() and will be available in the TUI application.

pub fn set_status_bar<W>(&mut self, status_bar: W) -> &mut TuiRunner

where W: Widget,

Set a custom status bar widget to replace the default.

pub fn hide_status_bar(&mut self) -> &mut TuiRunner

Hide the default status bar.

pub fn run(self) -> Result<(), Error>

Run the agent with the TUI.

This is the main entry point for running an agent with TUI. It:

1. Starts background tasks (controller, input router)
2. Creates an App with the configured settings
3. Wires up all channels and registries
4. Creates an initial session if LLM providers are configured
5. Runs the TUI event loop
6. Shuts down cleanly when the user quits