AttachDomain(domain_name)

Since: Version 20220624-141144-bd1b7c5d

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

Attempts to attach the named multiplexing domain. The name can be any of the names used in your ssh_domains, unix_domains or tls_clients configurations.

Attaching a domain will attempt to import the windows, tabs and panes from the remote system into those of the local GUI.

If there are no remote panes in that domain, wezterm will spawn a default program into it.

This action is not bound to any keys by default. The Launcher Menu (default: right click on the new tab + button in the tab bar) will synthesize entries with this action.

The example below shows how to bind a key to trigger attaching to an ssh domain:

config.ssh_domains = {
  {
    name = 'devhost',
    remote_address = 'devhost.example.com',
  },
}
config.keys = {
  {
    key = 'U',
    mods = 'CTRL|SHIFT',
    action = wezterm.action.AttachDomain 'devhost',
  },
}

See also: DetachDomain