Struct TerminalClient 

pub struct TerminalClient { /* private fields */ }

Terminal API client for sending terminal requests to the ACP Client

The Client (editor like Zed) manages the actual PTY, and this client sends requests through the ACP protocol to create, manage, and interact with terminals.

Implementations

impl TerminalClient

pub fn new( connection_cx: JrConnectionCx<AgentToClient>, session_id: impl Into<SessionId>, ) -> Self

Create a new Terminal API client

pub async fn create( &self, command: impl Into<String>, args: Vec<String>, cwd: Option<PathBuf>, output_byte_limit: Option<u64>, ) -> Result<TerminalId, AgentError>

Create a new terminal and execute a command

Returns a TerminalId that can be used with other terminal methods. The terminal will execute the specified command and capture output.

Arguments

• command - The command to execute
• args - Command arguments
• cwd - Optional working directory (uses session cwd if not specified)
• output_byte_limit - Optional limit on output bytes to retain

pub async fn output( &self, terminal_id: impl Into<TerminalId>, ) -> Result<TerminalOutputResponse, AgentError>

Get the current output and status of a terminal

Returns the output captured so far and the exit status if completed.

pub async fn wait_for_exit( &self, terminal_id: impl Into<TerminalId>, ) -> Result<WaitForTerminalExitResponse, AgentError>

Wait for a terminal command to exit

Blocks until the command completes and returns the exit status.

pub async fn kill( &self, terminal_id: impl Into<TerminalId>, ) -> Result<KillTerminalCommandResponse, AgentError>

Kill a terminal command

Sends SIGTERM to terminate the command. The terminal remains valid and can be queried for output or released.

pub async fn release( &self, terminal_id: impl Into<TerminalId>, ) -> Result<ReleaseTerminalResponse, AgentError>

Release a terminal and free its resources

After release, the TerminalId can no longer be used. Any unretrieved output will be lost.

pub fn session_id(&self) -> &SessionId

Get the session ID

pub fn into_arc(self) -> Arc<Self>

Create an Arc-wrapped client for sharing

Trait Implementations

impl Clone for TerminalClient

fn clone(&self) -> TerminalClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalClient

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

Formats the value using the given formatter.