⚡ Quick Domains

A faster way to search and attach to domains in wezterm. Inspired by smart_workpace_switcher.wezterm

Quick Look

Dependencies

There are no package dependencies, but you need to configured your .ssh/config Here to select ssh domains using auto-configuration with this plugin.

🚀 Install

This is a wezterm plugin. It can be installed by importing the repo and calling the apply_to_config function. It is important that the apply_to_config function is called after keys and key_tables have been set.

local domains = wezterm.plugin.require("https://github.com/DavidRR-F/quick_domains.wezterm")
domains.apply_to_config(config)

🎨 Configuration

The apply_to_config function takes a second parameter opts. To override any options simply pass a table of the desired changes.

domains.apply_to_config(
  config,
  {
    keys = {
      attach = {
        key  = 's',
        mods = 'SHIFT',
        tbl  = 'tmux'
      },
      vsplit = {
        key  = 'v',
        mods = 'SHIFT',
        tbl  = 'tmux'
      },
      hsplit = {
        key  = 'h',
        mods = 'SHIFT',
        tbl  = 'tmux'
      }
    }
  }
)

You can set a custom wezterm format for the domain fuzzy selector items

domains.formatter = function(icon, name, label)
  return wezterm.format({
    { Attribute = { Italic = true } },
    { Foreground = { AnsiColor = 'Fuchsia' } },
    { Background = { Color = 'blue' } },
    { Text = icon .. ' ' .. name .. ': ' .. label },
  })
end

You can enable auto configuration of ssh_domains and exec_domains by disabling the ignore configurations

{
  keys = ...,
  icons = ...,
  auto = {
    ssh_ignore = false,
    exec_ignore = {
      ssh = false,
      docker = false,
      kubernetes = false
    },
  }
}

🛠️ Defaults

These are the current default setting the can be overridden on your apply_to_config function

{
  keys = {
    -- open domain in new tab
    attach = {
      -- mod keys for fuzzy domain finder
      mods = 'CTRL',
      -- base key for fuzzy domain finder
      key = 'd',
      -- key table to insert key map to if any
      tbl = '',
    },
    -- open domain in split pane 
    -- excludes remote domains
    -- add remote domains as exec domain for split binds
    vsplit = {
      key  = 'v',
      mods = 'CTRL',
      tbl  = ''
    },
    hsplit = {
      key  = 'h',
      mods = 'CTRL',
      tbl  = ''
    }
 },
  -- swap in and out icons for specific domains
  icons = {
    hosts = '',
    ssh = '󰣀',
    tls = '󰢭',
    unix = '',
    exec = '',
    bash = '',
    zsh = '',
    fish = '',
    pwsh = '󰨊',
    powershell = '󰨊',
    wsl = '',
    windows = '',
    docker = '',
    kubernetes = '󱃾',
  },
  -- auto-configuration
  auto = {
    -- disable ssh multiplex auto config
    ssh_ignore = true,
    -- disable exec domain auto configs
    exec_ignore = {
      ssh = true,
      docker = true,
      kubernetes = true
    },
  },
  -- default shells
  docker_shell = '/bin/bash',
  kubernetes_shell = '/bin/bash'
}

This is the current default formatter function that can be overridden

domains.formatter = function(icon, name, _)
    return wezterm.format({ 
        { Text = icon .. ' ' .. string.lower(name) } 
    })
end

🔔 Events

quick_domain.fuzzy_selector.opened

parameter	description
window	MuxWindow Object
pane	MuxPane Object

quick_domain.fuzzy_selector.selected

parameter	description
window	MuxWindow Object
pane	MuxPane Object
id	Domain ID

quick_domain.fuzzy_selector.canceled

parameter	description
window	MuxWindow Object
pane	MuxPane Object