Struct ShellOptions 

pub struct ShellOptions {
    pub init_profile: Option<ShellInitProfile>,
    pub init_scripts: Option<Vec<ShellInitScript>>,
    pub process_flags: Option<Vec<String>>,
}

Per-session settings for built-in shell tools.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

init_profile: Option<ShellInitProfile>

Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected.

init_scripts: Option<Vec<ShellInitScript>>

Ordered host-provided script paths sourced before each built-in shell command when the entry’s shell target matches the active shell. Use these for rc files, environment setup scripts, or other custom scripts. A script that returns a nonzero status is reported, and later scripts and the user command continue while the shell remains running. Because scripts are sourced into the command shell, exit, exec, failures under set -e, or other shell-terminating behavior can prevent continuation. Script standard output is preserved; Bash script stderr is discarded, PowerShell exception messages are replaced, and runtime-generated failure notices omit configured script paths. When sandboxing is enabled, each script must already be readable under the active sandbox filesystem policy. Pass an empty array to clear the list.

process_flags: Option<Vec<String>>

Flags passed to the active built-in shell process on startup, replacing its default flags. When omitted, the built-in Bash shell uses --norc --noprofile, and the built-in PowerShell shell uses -NoProfile -NoLogo.

Trait Implementations

impl Clone for ShellOptions

fn clone(&self) -> ShellOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellOptions

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

Formats the value using the given formatter.

impl Default for ShellOptions

fn default() -> ShellOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShellOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ShellOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.