bmux_cli 0.0.1-alpha.1

Command-line interface for bmux terminal multiplexer
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
86
87
88
89
90
91
92
93
94
95
96
97

use anyhow::Result;
use bmux_client::BmuxClient;
use tokio::sync::oneshot;

pub use crate::runtime::attach::adapters::{
    AttachAdapterFuture, AttachClock, AttachEventBus, AttachEventEnvelope, AttachRenderSink,
    AttachScheduledWake, AttachScheduler, AttachServiceCall, AttachServiceHost, AttachStorage,
    AttachStorageKey, AttachTerminalInputSource, FixedAttachClock, SystemAttachClock,
};
pub use crate::runtime::attach::input::{
    TerminalGeometry, TerminalInputEvent, TerminalKeyCode, TerminalKeyEvent, TerminalKeyPhase,
    TerminalModifiers, TerminalMouseButton, TerminalMouseEvent, TerminalMousePhase,
};
pub use crate::runtime::{
    ActionDispatchError, ActionDispatchRequest, AttachExitReason, AttachRunOutcome, PromptEvent,
    PromptField, PromptOption, PromptPolicy, PromptRequest, PromptResponse, PromptSubmitError,
    PromptValidation, PromptValue, PromptWidth,
};

/// Run the attach TUI using an already-connected client.
///
/// # Errors
/// Returns an error when attach setup or runtime processing fails.
pub async fn run_with_client(
    client: BmuxClient,
    target: Option<&str>,
    follow: Option<&str>,
    global: bool,
) -> Result<AttachRunOutcome> {
    crate::runtime::run_attach_with_client(client, target, follow, global).await
}

/// Submit a prompt request to the active attach host.
///
/// # Errors
/// Returns an error if no prompt host is available or if host delivery fails.
pub fn submit_prompt(
    request: PromptRequest,
) -> std::result::Result<oneshot::Receiver<PromptResponse>, PromptSubmitError> {
    crate::runtime::submit_prompt_request(request)
}

/// Submit a prompt request and receive live prompt events.
///
/// # Errors
/// Returns an error if no prompt host is available or if host delivery fails.
pub fn submit_prompt_with_events(
    request: PromptRequest,
) -> std::result::Result<
    (
        oneshot::Receiver<PromptResponse>,
        tokio::sync::mpsc::UnboundedReceiver<PromptEvent>,
    ),
    PromptSubmitError,
> {
    crate::runtime::submit_prompt_request_with_events(request)
}

/// Submit a prompt request and wait for its response.
///
/// # Errors
/// Returns an error if no prompt host is available or if host delivery fails.
pub async fn request_prompt(
    request: PromptRequest,
) -> std::result::Result<PromptResponse, PromptSubmitError> {
    crate::runtime::request_prompt_response(request).await
}

/// Submit a prompt request, wait for its response, and return live events.
///
/// # Errors
/// Returns an error if no prompt host is available or if host delivery fails.
pub async fn request_prompt_with_events(
    request: PromptRequest,
) -> std::result::Result<
    (
        PromptResponse,
        tokio::sync::mpsc::UnboundedReceiver<PromptEvent>,
    ),
    PromptSubmitError,
> {
    crate::runtime::request_prompt_response_with_events(request).await
}

/// Dispatch a runtime action string to the attach loop.
///
/// The action string uses the same format as keybinding action values
/// (e.g. `"focus_next_pane"`, `"plugin:bmux.windows:goto-window 1"`).
///
/// This is intended for async plugin code that has collected parameters
/// (e.g. via prompts) and needs to execute an action with those values.
///
/// # Errors
/// Returns an error if no dispatch host is registered or the channel is closed.
pub fn dispatch_action(action: impl Into<String>) -> std::result::Result<(), ActionDispatchError> {
    crate::runtime::dispatch_action(action)
}