Skip to content



Since: Version 20220624-141144-bd1b7c5d

The functionality described in this section requires version 20220624-141144-bd1b7c5d of wezterm, or a more recent version.

Spawns a program into a new tab within this window, returning the MuxTab, Pane and MuxWindow objects associated with it:

local tab, pane, window = window:spawn_tab {}

When no arguments are passed, the default program is spawned.

The following parameters are supported:


Specifies the argument array for the command that should be spawned. If omitted the default program for the domain will be spawned.

window:spawn_tab { args = { 'top' } }


Specify the current working directory that should be used for the program.

If unspecified, follows the rules from default_cwd

window:spawn_tab { cwd = '/tmp' }


Sets additional environment variables in the environment for this command invocation.

window:spawn_tab { set_environment_variables = { FOO = 'BAR' } }


Specifies the multiplexer domain into which the program should be spawned. The default value is assumed to be "CurrentPaneDomain", which causes the domain from the currently active pane to be used.

You may specify the name of one of the multiplexer domains defined in your configuration using the following:

window:spawn_tab { domain = { DomainName = '' } }