yolop 0.9.0

Yolop — a terminal coding agent built on everruns-runtime
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Host UI port for client-executed slash commands.
//!
//! A handful of slash commands act on the terminal client itself — clear the
//! transcript, open the model/effort overlay, run a local shell command, print
//! local info, quit — rather than on the agent runtime. They are nonetheless
//! ordinary capabilities (see
//! [`crate::capabilities::ClientCommandsCapability`]) so that every command
//! lives in one registry. Their `execute_command` runs on the runtime's task
//! and cannot touch the TUI directly, so it instead calls this port, which
//! forwards a typed [`UiCommand`] to the terminal event loop over a channel.
//! The loop is the only thing that can perform the effect, so it applies it.

use tokio::sync::{mpsc, oneshot};

/// A server→host `ui/ask`: prompt the user and deliver their answer via
/// `reply`. Carried on its own channel rather than as a [`UiCommand`] variant
/// because the oneshot sender can't derive `Clone`/`Eq`.
pub struct AskRequest {
    pub prompt: String,
    pub placeholder: Option<String>,
    pub reply: oneshot::Sender<AskAnswer>,
}

/// The user's answer to a [`AskRequest`] (empty + `cancelled` on dismiss).
#[derive(Clone, Debug, Default)]
pub struct AskAnswer {
    pub answer: String,
    pub cancelled: bool,
}

/// A request from a client-executed capability command to the terminal host.
/// Variants name *what* should happen; the host decides *how* to render it.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum UiCommand {
    /// Print the command palette / input help.
    ShowHelp,
    /// Print the list of available tools.
    ShowTools,
    /// Inspect or update configured MCP servers.
    ManageMcp { arg: Option<String> },
    /// Print the workspace root.
    ShowCwd,
    /// Change the inline session status layout.
    SetStatusLayout { arg: Option<String> },
    /// Clear the transcript buffer.
    ClearTranscript,
    /// Run a shell command from the workspace root.
    RunShell { command: String },
    /// Exit the application.
    Quit,
    /// Open the interactive model picker. `arg` pre-seeds the selection.
    OpenModelOverlay { arg: Option<String> },
    /// Open the interactive reasoning-effort picker. `arg` pre-seeds it.
    OpenEffortOverlay { arg: Option<String> },
    /// Set (or, when `status` is empty, clear) an extension's status-bar field.
    /// Pushed by an extension server's `status/changed` notification.
    SetExtensionStatus { ext: String, status: String },
}

/// What a client-executed command can ask the host UI to do. Implemented per
/// host (the TUI's [`TuiHandle`]); a host that cannot honor client commands
/// simply never registers the capability that depends on this port.
pub trait HostUi: Send + Sync {
    fn send(&self, command: UiCommand);
}

/// TUI implementation of [`HostUi`]: every call is a non-blocking channel
/// send. The matching receiver is drained by the `App` event loop.
pub struct TuiHandle {
    tx: mpsc::UnboundedSender<UiCommand>,
}

impl TuiHandle {
    pub fn new(tx: mpsc::UnboundedSender<UiCommand>) -> Self {
        Self { tx }
    }
}

impl HostUi for TuiHandle {
    fn send(&self, command: UiCommand) {
        // The receiver lives as long as the `App`; a failed send only happens
        // during shutdown, where dropping the command is the correct behavior.
        let _ = self.tx.send(command);
    }
}