Struct CreateTerminalOptions 

pub struct CreateTerminalOptions {
    pub cwd: Option<String>,
    pub direction: Option<String>,
    pub ratio: Option<f32>,
    pub focus: Option<bool>,
    pub persistent: Option<bool>,
    pub window_id: Option<WindowId>,
    pub command: Option<Vec<String>>,
    pub title: Option<String>,
}

Options for createTerminal

Fields

cwd: Option<String>

Working directory for the terminal (defaults to editor cwd)

direction: Option<String>

Split direction: “horizontal” or “vertical” (default: “vertical”)

ratio: Option<f32>

Split ratio 0.0-1.0 (default: 0.5)

focus: Option<bool>

Whether to focus the new terminal split (default: true)

persistent: Option<bool>

Whether this terminal is part of the user’s persisted workspace. Defaults to false for plugin-created terminals — they are typically one-off tool UIs (rebuilds, exec shells, build output) and should start with empty scrollback on each invocation. Set to true only when the plugin owns a terminal that the user should see restored across editor restarts.

window_id: Option<WindowId>

Optional session id to attach the new terminal buffer to. Defaults to the active session at creation time. Setting this lets Orchestrator and similar plugins spawn a terminal into an inactive session (e.g. an agent in a worktree the user hasn’t dived into yet). The terminal’s split is created in that session’s stashed split tree; the buffer is attached to the target session’s membership set rather than the active one’s.

command: Option<Vec<String>>

Argv to spawn directly inside the PTY instead of the host’s configured shell. None (default) keeps the historical behaviour: spawn the user’s shell and let the caller type into it via sendTerminalInput. Some([cmd, ...args]) runs that exact command as the PTY child — no shell middleman, so the process exits cleanly when the agent does and the terminal-buffer’s terminal_exit plugin hook reflects the agent’s real exit status. Used by Orchestrator so a session with agent python3 is just python3 in the PTY rather than bash-running-python3-as-a-subshell-command.

title: Option<String>

Tab title for the terminal buffer. Defaults to command[0] (when command is set) or "Terminal N" (the historical auto-numbered title). If another terminal in the same window already uses the requested title, the host appends " (k)" to disambiguate. Empty string is treated the same as None.

Trait Implementations

impl Clone for CreateTerminalOptions

fn clone(&self) -> CreateTerminalOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTerminalOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateTerminalOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'js> FromJs<'js> for CreateTerminalOptions

fn from_js( _ctx: &Ctx<'js>, value: Value<'js>, ) -> Result<CreateTerminalOptions, Error>

impl Serialize for CreateTerminalOptions

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 TS for CreateTerminalOptions

type WithoutGenerics = CreateTerminalOptions

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = CreateTerminalOptions

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where CreateTerminalOptions: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where CreateTerminalOptions: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.