Enum ScriptCommand 

pub enum ScriptCommand {
    WriteText {
        text: String,
    },
    Notify {
        title: String,
        body: String,
    },
    SetBadge {
        text: String,
    },
    SetVariable {
        name: String,
        value: String,
    },
    RunCommand {
        command: String,
    },
    ChangeConfig {
        key: String,
        value: Value,
    },
    Log {
        level: String,
        message: String,
    },
    SetPanel {
        title: String,
        content: String,
    },
    ClearPanel {},
    SetOverlay {
        id: String,
        position: OverlayPosition,
        size: OverlaySize,
        opacity: f32,
        interactive: bool,
        content: OverlayScene,
    },
    ClearOverlay {
        id: String,
    },
    SetWidget {
        text: String,
    },
}

A command sent from a script subprocess to the terminal (via stdout).

Tagged with type for easy JSON dispatch.

Variants

WriteText

Write text to the PTY.

Fields

text: String

Text to write.

Notify

Show a desktop notification.

Fields

title: String

Notification title.

body: String

Notification body.

SetBadge

Set the tab badge text.

Fields

text: String

Badge text to display.

SetVariable

Set a user variable.

Fields

name: String

Variable name.

value: String

Variable value.

RunCommand

Execute a shell command.

Fields

command: String

Command to execute.

ChangeConfig

Change a configuration value.

Fields

key: String

Configuration key.

value: Value

New value.

Log

Log a message.

Fields

level: String

Log level (e.g., “info”, “warn”, “error”, “debug”).

message: String

Log message.

SetPanel

Set a markdown panel.

Fields

title: String

Panel title.

content: String

Markdown content.

ClearPanel

Clear the markdown panel.

SetOverlay

Upsert a plugin-owned overlay surface (overlay kind only). Idempotent by id: same id replaces the whole overlay. Phase 1 is display-only — the host forces interactive off pending the manifest capability.

Fields

id: String

Overlay id; unique within the plugin.

position: OverlayPosition

Position: a named anchor or a free rect (fractions of window).

size: OverlaySize

Size as fractions of the window (0.0–1.0).

opacity: f32

Opacity (0.0–1.0, default 1.0).

interactive: bool

Interactive request; forced off without the manifest capability.

content: OverlayScene

Scene to render (declarative tree).

ClearOverlay

Clear a plugin-owned overlay by id (overlay kind only).

Fields

id: String

Overlay id to remove.

SetWidget

Set the text of a plugin-provided status-bar widget.

Display-only and plugin-sourced: no permission flag exists for it because a widget’s text is strictly less powerful than SetBadge (which scripts already send unrestricted). A tab script emitting this command gets an error line in its output pane — the plugin host is the only consumer.

Fields

text: String

Widget text to display (last write wins; empty text hides the widget).

Implementations

impl ScriptCommand

pub fn requires_permission(&self) -> bool

Returns true if this command requires explicit permission in the script config.

Commands that return true must have their corresponding allow_* flag set in ScriptConfig before the dispatcher will execute them.

Security Classification

Command	Requires Permission	Risk Level
Log	No	Low (UI output only)
SetPanel / ClearPanel	No	Low (UI display only)
Notify	No	Low (desktop notification)
SetBadge	No	Low (tab badge display)
SetVariable	No	Low (user variable storage)
WriteText	Yes	High (PTY injection, command execution)
RunCommand	Yes	Critical (arbitrary process spawn)
ChangeConfig	Yes	High (config modification)

pub fn permission_flag_name(&self) -> Option<&'static str>

Returns the name of the permission flag required to execute this command.

Returns None for commands that don’t require permission. The returned string corresponds to a field in ScriptConfig:

• "allow_run_command" for RunCommand
• "allow_write_text" for WriteText
• "allow_change_config" for ChangeConfig

pub fn is_rate_limited(&self) -> bool

Returns true if this command can safely be executed without rate limiting.

Commands that may be emitted frequently (like Log) should not be rate-limited to avoid dropping important debug output. High-impact commands (WriteText, RunCommand) must be rate-limited to prevent abuse.

pub fn command_name(&self) -> &'static str

Returns a human-readable name for this command type (for logging/errors).

Trait Implementations

impl Clone for ScriptCommand

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScriptCommand

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ScriptCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScriptCommand