Struct ScriptConfig 

pub struct ScriptConfig {

    pub name: String,
    pub enabled: bool,
    pub script_path: String,
    pub args: Vec<String>,
    pub auto_start: bool,
    pub restart_policy: RestartPolicy,
    pub restart_delay_ms: u64,
    pub subscriptions: Vec<String>,
    pub env_vars: HashMap<String, String>,
    pub allow_write_text: bool,
    pub prompt_before_write_text: bool,
    pub allow_run_command: bool,
    pub allow_change_config: bool,
    pub write_text_rate_limit: u32,
    pub run_command_rate_limit: u32,
}

Configuration for an external observer script that receives terminal events via JSON protocol.

Fields

name: String

Human-readable name for this script

enabled: bool

Whether this script is enabled (default: true)

script_path: String

Path to the script executable

args: Vec<String>

Arguments to pass to the script

auto_start: bool

Whether to start this script automatically when a tab opens

restart_policy: RestartPolicy

Policy for restarting the script when it exits

restart_delay_ms: u64

Delay in milliseconds before restarting (when restart_policy is not Never)

subscriptions: Vec<String>

Event types to subscribe to (empty = all events)

env_vars: HashMap<String, String>

Additional environment variables to set for the script process

allow_write_text: bool

Allow this script to inject text into the active PTY via WriteText.

Defaults to false. Must be explicitly set to true to enable. When enabled, VT/ANSI escape sequences are stripped before writing and a rate limit is applied (see write_text_rate_limit).

prompt_before_write_text: bool

Ask before each WriteText injection from this script.

Defaults to true, mirroring prompt_before_run on triggers. Stripping escape sequences does not make an injection safe — the payload that runs a command is ordinary printable text plus a newline — so confirmation, not filtering, is the control on this path. Set to false to write immediately; the write is still sanitized and rate limited.

allow_run_command: bool

Allow this script to spawn external processes via RunCommand.

Defaults to false. Must be explicitly set to true to enable. When enabled, the command is checked against the denylist and a rate limit is applied (see run_command_rate_limit).

allow_change_config: bool

Allow this script to modify runtime configuration via ChangeConfig.

Defaults to false. Must be explicitly set to true to enable. Only keys in the runtime allowlist may be changed.

write_text_rate_limit: u32

Maximum WriteText writes per second (0 = use default of 10/s).

run_command_rate_limit: u32

Maximum RunCommand executions per second (0 = use default of 1/s).

Implementations

impl ScriptConfig

pub fn should_auto_start(&self) -> bool

Whether this script should be started automatically when a tab is created.

A script auto-starts only when it is both enabled and opted in via auto_start; enabled: false disables the script entirely, including auto-start, matching the manual start path in the Settings UI.

Trait Implementations

impl Clone for ScriptConfig

fn clone(&self) -> ScriptConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<ScriptConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScriptConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScriptConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScriptConfig