Struct CreateOptions 

pub struct CreateOptions {

    pub disabled_options: Vec<String>,
    pub enabled_options: Vec<String>,
    pub disabled_shopt_options: Vec<String>,
    pub enabled_shopt_options: Vec<String>,
    pub builtins: HashMap<String, Registration>,
    pub working_dir: Option<PathBuf>,
    pub disallow_overwriting_regular_files_via_output_redirection: bool,
    pub do_not_execute_commands: bool,
    pub exit_after_one_command: bool,
    pub interactive: bool,
    pub login: bool,
    pub no_editing: bool,
    pub no_profile: bool,
    pub no_rc: bool,
    pub rc_file: Option<PathBuf>,
    pub do_not_inherit_env: bool,
    pub fds: Option<HashMap<ShellFd, OpenFile>>,
    pub posix: bool,
    pub print_commands_and_arguments: bool,
    pub read_commands_from_stdin: bool,
    pub shell_name: Option<String>,
    pub shell_product_display_str: Option<String>,
    pub sh_mode: bool,
    pub treat_unset_variables_as_error: bool,
    pub verbose: bool,
    pub command_string_mode: bool,
    pub max_function_call_depth: Option<usize>,
    pub key_bindings: Option<Arc<Mutex<dyn KeyBindings>>>,
    pub error_formatter: Option<Arc<Mutex<dyn ErrorFormatter>>>,
    pub shell_version: Option<String>,
}

Options for creating a new shell.

Fields

disabled_options: Vec<String>

Disabled options.

enabled_options: Vec<String>

Enabled options.

disabled_shopt_options: Vec<String>

Disabled shopt options.

enabled_shopt_options: Vec<String>

Enabled shopt options.

builtins: HashMap<String, Registration>

Registered builtins. Defaults to full bash-compatible builtins.

working_dir: Option<PathBuf>

Optional override for initial working directory. If None, defaults to std::env::current_dir(). When provided, the shell will start in this directory instead of inheriting the process’s current directory.

This is critical for HTTP-based MCP tools where the shell should start in the CLIENT’s working directory, not the SERVER’s.

disallow_overwriting_regular_files_via_output_redirection: bool

Disallow overwriting regular files via output redirection.

do_not_execute_commands: bool

Do not execute commands.

exit_after_one_command: bool

Exit after one command.

interactive: bool

Whether the shell is interactive.

login: bool

Whether the shell is a login shell.

no_editing: bool

Whether to skip using a readline-like interface for input.

no_profile: bool

Whether to skip sourcing the system profile.

no_rc: bool

Whether to skip sourcing the user’s rc file.

rc_file: Option<PathBuf>

Explicit override of rc file to load in interactive mode.

do_not_inherit_env: bool

Whether to skip inheriting environment variables from the calling process.

fds: Option<HashMap<ShellFd, OpenFile>>

Provides a set of initial open files to be tracked by the shell.

posix: bool

Whether the shell is in POSIX compliance mode.

print_commands_and_arguments: bool

Whether to print commands and arguments as they are read.

read_commands_from_stdin: bool

Whether commands are being read from stdin.

shell_name: Option<String>

The name of the shell.

shell_product_display_str: Option<String>

Optionally provides a display string describing the version and variant of the shell.

sh_mode: bool

Whether to run in maximal POSIX sh compatibility mode.

treat_unset_variables_as_error: bool

Whether to treat expansion of unset variables as an error.

verbose: bool

Whether to print verbose output.

command_string_mode: bool

Whether the shell is in command string mode (-c).

max_function_call_depth: Option<usize>

Maximum function call depth.

key_bindings: Option<Arc<Mutex<dyn KeyBindings>>>

Key bindings helper for the shell to use.

error_formatter: Option<Arc<Mutex<dyn ErrorFormatter>>>

Error formatter helper for the shell to use.

shell_version: Option<String>

Brush implementation version.

Trait Implementations

impl Default for CreateOptions

fn default() -> CreateOptions

Returns the “default value” for a type.