Enum CliCommand 

pub enum CliCommand {
    Keys {
        keys: String,
        client: u64,
    },
    Mode {
        client: u64,
    },
    Cursor {
        client: u64,
    },
    Buffers,
    Buffer {
        id: Option<u64>,
    },
    Registers {
        name: Option<String>,
    },
    Capture {
        client: Option<u64>,
        capture_format: String,
        web_url: Option<String>,
        width: u32,
        height: u32,
        dpr: u32,
        output: Option<String>,
    },
    Ping,
    Version,
    Clients,
    ExtensionState {
        kind: String,
        client: u64,
    },
    Extensions,
}

CLI commands.

Variants

Keys

Send keys to a specific client.

Fields

keys: String

Keys in vim notation (e.g., iHello<Esc>).

client: u64

Target client ID to send keys to (required).

Mode

Get a specific client’s editor mode.

Fields

client: u64

Target client ID to query mode from (required).

Cursor

Get a specific client’s cursor position.

Fields

client: u64

Target client ID to query cursor from (required).

Buffers

List open buffers.

Buffer

Get buffer content.

Fields

id: Option<u64>

Buffer ID (uses active buffer if not specified).

Registers

Get register contents.

Without arguments, lists all non-empty registers. With a register name, shows that register’s content.

Fields

name: Option<String>

Register name (e.g., “a”, “"”, “0”).

Capture

Capture screen content.

For text formats (plain_text, raw_ansi, cell_grid): captures via gRPC relay from a connected TUI client (requires --client).

For visual formats (png, html): captures via Playwright headless browser running the real web client (requires --web-url).

Fields

client: Option<u64>

Target client ID (required for text capture, ignored for web capture).

capture_format: String

Capture format: raw_ansi, plain_text, cell_grid, png, html.

web_url: Option<String>

Web client URL for visual capture (required for png/html formats).

width: u32

Viewport width in pixels (web capture only).

height: u32

Viewport height in pixels (web capture only).

dpr: u32

Device pixel ratio (web capture only).

output: Option<String>

Output file path (web capture only; stdout if omitted).

Ping

Ping the server (health check).

Version

Get server version and info.

Clients

List connected clients (read-only debug query).

ExtensionState

Query extension state (e.g., which-key, cmdline).

Fields

kind: String

Extension kind to query (e.g., “whichkey”, “cmdline”).

client: u64

Target client ID.

Extensions

List registered extensions.

Trait Implementations

impl Debug for CliCommand

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

Formats the value using the given formatter.

impl FromArgMatches for CliCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for CliCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand