# My Wezterm Setup This is my Wezterm setup. My goal was to allow Wezterm to replace tmux, as I wanted a way to essentially have the features I use most from tmux always available — pane splitting, tab creation, and session management. My keybindings mimic those I used in tmux for creating new panes and tabs. I'd previously used tmux-resurrect to manage my tmux sessions, and relied on its ability to save state periodically. For wezterm, I'm using resurrect.wezterm, with a number of configurations based on my own usage, and I use the same keybindings for naming sessions, saving sessions, and loading sessions, as I did in tmux. In my own setup, the smart-splits and resurrect configurations are in separate subdirectories; I've adapted the gist to a flat file structure.

-- From https://alexplescan.com/posts/2024/08/10/wezterm/ local wezterm = require 'wezterm' local module = {} -- Returns a bool based on whether the host operating system's -- appearance is light or dark. function module.is_dark() -- wezterm.gui is not always available, depending on what -- environment wezterm is operating in. Just return true -- if it's not defined. if wezterm.gui then -- Some systems report appearance like "Dark High Contrast" -- so let's just look for the string "Dark" and if we find -- it assume appearance is dark. return wezterm.gui.get_appearance():find("Dark") end return true end return module

-- Provide generalized functionality for merging tables local merge = {} function merge.all(base, overrides) local ret = base or {} local second = overrides or {} for _, v in pairs(second) do table.insert(ret, v) end return ret end return merge

local wezterm = require 'wezterm' local module = {} local function has_value (tab, val) for index, value in ipairs(tab) do -- luacheck: ignore 213 if value == val then return true end end return false end local function notify (subject, msg, urgency) local allowed_urgency = { 'low', 'normal', 'critical' } urgency = urgency or 'normal' if not has_value(allowed_urgency, urgency) then urgency = 'normal' end wezterm.run_child_process { 'notify-send', '-i', 'org.wezfurlong.wezterm', '-a', 'wezterm', '-u', urgency, subject, msg } end module.send = notify return module

-- From https://alexplescan.com/posts/2024/08/10/wezterm/ local wezterm = require 'wezterm' local appearance = require 'appearance' local function segments_for_right_status(window) return { window:active_workspace() .. ' ', wezterm.strftime('%a %Y-%m-%d %H:%M '), wezterm.hostname(), } end wezterm.on('update-status', function(window, _) local SOLID_LEFT_ARROW = utf8.char(0xe0b2) local segments = segments_for_right_status(window) local color_scheme = window:effective_config().resolved_palette -- Note the use of wezterm.color.parse here, this returns -- a Color object, which comes with functionality for lightening -- or darkening the colour (amongst other things). local bg = wezterm.color.parse(color_scheme.background) local fg = color_scheme.foreground -- Each powerline segment is going to be coloured progressively -- darker/lighter depending on whether we're on a dark/light colour -- scheme. Let's establish the "from" and "to" bounds of our gradient. local gradient_to, gradient_from = bg if appearance.is_dark() then gradient_from = gradient_to:lighten(0.2) else gradient_from = gradient_to:darken(0.2) end -- Yes, WezTerm supports creating gradients, because why not?! Although -- they'd usually be used for setting high fidelity gradients on your terminal's -- background, we'll use them here to give us a sample of the powerline segment -- colours we need. local gradient = wezterm.color.gradient( { orientation = 'Horizontal', colors = { gradient_from, gradient_to }, }, #segments -- only gives us as many colours as we have segments. ) -- We'll build up the elements to send to wezterm.format in this table. local elements = {} for i, seg in ipairs(segments) do local is_first = i == 1 if is_first then table.insert(elements, { Background = { Color = 'none' } }) end table.insert(elements, { Foreground = { Color = gradient[i] } }) table.insert(elements, { Text = SOLID_LEFT_ARROW }) table.insert(elements, { Foreground = { Color = fg } }) table.insert(elements, { Background = { Color = gradient[i] } }) table.insert(elements, { Text = ' ' .. seg .. ' ' }) end window:set_right_status(wezterm.format(elements)) end)

-- resurrect.wezterm configuration and settings -- -- This module: -- * Configures the resurrect.wezterm plugin -- * Configures event listener configuration (via an additional required file) -- * Returns wezterm keybinding configuration for resurrect-related actions. -- -- The main wezterm configuration is then responsible for merging the -- keybindings with other keybindings, or setting up its own. local config = {} local wezterm = require 'wezterm' local resurrect = wezterm.plugin.require("https://github.com/MLFlexer/resurrect.wezterm") -- resurrect.wezterm encryption -- Uncomment the following to use encryption. -- If you do, ensure you have the age tool installed, you have created an -- encryption key at ~/.config/age/wezterm-resurrect.txt, and that you supply -- the associated public_key below resurrect.set_encryption({ enable = true, method = "age", private_key = wezterm.home_dir .. "/.config/age/wezterm-resurrect.txt", public_key = "PUBLIC-KEY-GOES-HERE", }) -- resurrect.wezterm periodic save every 5 minutes resurrect.periodic_save({ interval_seconds = 300, save_tabs = true, save_windows = true, save_workspaces = true, }) -- Save only 5000 lines per pane resurrect.set_max_nlines(5000) -- Default keybindings -- These will need to be merged with the main wezterm keys. config.keys = { { -- Save current and window state -- See https://github.com/MLFlexer/resurrect.wezterm for options around -- saving workspace and window state separately key = 'S', mods = 'LEADER|SHIFT', action = wezterm.action_callback(function(win, pane) -- luacheck: ignore 212 local state = resurrect.workspace_state.get_workspace_state() resurrect.save_state(state) resurrect.window_state.save_window_action() end), }, { -- Load workspace or window state, using a fuzzy finder key = 'L', mods = 'LEADER|SHIFT', action = wezterm.action_callback(function(win, pane) resurrect.fuzzy_load(win, pane, function(id, label) -- luacheck: ignore 212 local type = string.match(id, "^([^/]+)") -- match before '/' id = string.match(id, "([^/]+)$") -- match after '/' id = string.match(id, "(.+)%..+$") -- remove file extension local opts = { window = win:mux_window(), relative = true, restore_text = true, on_pane_restore = resurrect.tab_state.default_on_pane_restore, } if type == "workspace" then local state = resurrect.load_state(id, "workspace") resurrect.workspace_state.restore_workspace(state, opts) elseif type == "window" then local state = resurrect.load_state(id, "window") -- opts.tab = win:active_tab() resurrect.window_state.restore_window(pane:window(), state, opts) elseif type == "tab" then local state = resurrect.load_state(id, "tab") resurrect.tab_state.restore_tab(pane:tab(), state, opts) end end) end), }, { -- Delete a saved session using a fuzzy finder key = 'd', mods = 'LEADER|SHIFT', action = wezterm.action_callback(function(win, pane) resurrect.fuzzy_load( win, pane, function(id) resurrect.delete_state(id) end, { title = 'Delete State', description = 'Select session to delete and press Enter = accept, Esc = cancel, / = filter', fuzzy_description = 'Search session to delete: ', is_fuzzy = true, } ) end), } } require 'resurrect-events' return config

-- resurrect.wezterm event listener configuration -- -- This module configures event listeners for the resurrect.wezterm plugin. local wezterm = require 'wezterm' local notify = require '../notify' local suppress_notification = false wezterm.on('resurrect.error', function (error) notify.send("Wezterm - ERROR", error, 'critical') end) wezterm.on('resurrect.periodic_save', function () suppress_notification = true end) wezterm.on('resurrect.save_state.finished', function (session_path) local is_workspace_save = session_path:find("state/workspace") if is_workspace_save == nil then return end if suppress_notification then suppress_notification = false return end local path = session_path:match(".+/([^+]+)$") local name = path:match("^(.+)%.json$") notify.send("Wezterm - Save workspace", 'Saved workspace ' .. name .. "\n\n" .. session_path) end) wezterm.on('resurrect.load_state.finished', function(name, type) local msg = 'Completed loading ' .. type .. ' state: ' .. name notify.send("Wezterm - Restore session", msg) end)

local w = require('wezterm') -- if you are *NOT* lazy-loading smart-splits.nvim (recommended) local function is_vim(pane) -- this is set by the plugin, and unset on ExitPre in Neovim return pane:get_user_vars().IS_NVIM == 'true' end local direction_keys = { h = 'Left', j = 'Down', k = 'Up', l = 'Right', } local function split_nav(resize_or_move, key) return { key = key, mods = resize_or_move == 'resize' and 'META' or 'CTRL', action = w.action_callback(function(win, pane) if is_vim(pane) then -- pass the keys through to vim/nvim win:perform_action({ SendKey = { key = key, mods = resize_or_move == 'resize' and 'META' or 'CTRL' }, }, pane) else if resize_or_move == 'resize' then win:perform_action({ AdjustPaneSize = { direction_keys[key], 3 } }, pane) else win:perform_action({ ActivatePaneDirection = direction_keys[key] }, pane) end end end), } end return { keys = { -- move between split panes split_nav('move', 'h'), split_nav('move', 'j'), split_nav('move', 'k'), split_nav('move', 'l'), -- resize panes split_nav('resize', 'h'), split_nav('resize', 'j'), split_nav('resize', 'k'), split_nav('resize', 'l'), }, }

local wezterm = require 'wezterm' wezterm.on( 'format-tab-title', function(tab, tabs, panes, config, hover, max_width) if tab.is_active then -- Do nothing; normal active style is fine, so just return the text return tab.active_pane.title end local has_unseen_output = false for _, pane in ipairs(tab.panes) do if pane.has_unseen_output then has_unseen_output = true break end end if has_unseen_output then -- Set the background to Solarized's yellow, and foreground to -- Solarized's base02 return { { Background = { Color = '#b58900' } }, { Foreground = { Color = '#073642' } }, { Text = ' ' .. tab.active_pane.title .. ' ' }, } end -- Do nothing different, as there's no activity; just return the text return tab.active_pane.title end )

-- Pull in the wezterm API, some of its modules, and plugins local wezterm = require 'wezterm' local act = wezterm.action local merge = require 'merge' local mux = wezterm.mux local resurrect = require 'resurrect-config' local smart_splits = require 'smart-splits-setup' -- -------------------------------------------------------------------- -- CONFIGURATION -- -------------------------------------------------------------------- -- This table will hold the configuration. local config = {} -- In newer versions of wezterm, use the config_builder which will -- help provide clearer error messages if wezterm.config_builder then config = wezterm.config_builder() end config.adjust_window_size_when_changing_font_size = false config.automatically_reload_config = true config.color_scheme = 'Solarized (dark) (terminal.sexy)' config.enable_scroll_bar = true config.enable_wayland = true -- config.font = wezterm.font('Hack') config.font = wezterm.font('MonaspiceNe NFP') config.font_size = 12.0 config.hide_tab_bar_if_only_one_tab = false -- The leader is similar to how tmux defines a set of keys to hit in order to -- invoke tmux bindings. Binding to ctrl-a here to mimic tmux config.leader = { key = 'a', mods = 'CTRL', timeout_milliseconds = 2000 } config.mouse_bindings = { -- Open URLs with Ctrl+Click { event = { Up = { streak = 1, button = 'Left' } }, mods = 'CTRL', action = act.OpenLinkAtMouseCursor, } } config.pane_focus_follows_mouse = true config.scrollback_lines = 5000 config.tiling_desktop_environments = { 'Wayland', } config.use_dead_keys = false config.warn_about_missing_glyphs = false config.window_decorations = "TITLE | RESIZE" config.window_padding = { left = 0, right = 0, top = 0, bottom = 0, } -- Tab bar config.use_fancy_tab_bar = true config.tab_bar_at_bottom = true config.switch_to_last_active_tab_when_closing_tab = true config.tab_max_width = 32 config.colors = { quick_select_label_bg = { Color = '#fdf6e3' }, quick_select_label_fg = { Color = '#073642' }, tab_bar = { active_tab = { fg_color = '#073642', bg_color = '#2aa198', } } } -- Add items to launch menu config.launch_menu = { { label = 'mwop', cwd = wezterm.home_dir .. '/git/weierophinney/mwop.net', }, { label = 'onedrive', cwd = wezterm.home_dir .. '/OneDrive', }, { label = 'top', args = { 'top' }, }, } -- Custom key bindings config.keys = { -- Show the launcher { key = 'm', mods = 'LEADER', action = act.ShowLauncher, }, -- Copy mode { key = '[', mods = 'LEADER', action = act.ActivateCopyMode, }, -- ---------------------------------------------------------------- -- TABS -- -- Where possible, I'm using the same combinations as I would in tmux -- ---------------------------------------------------------------- -- Show tab navigator; similar to listing panes in tmux { key = 'w', mods = 'LEADER', action = act.ShowTabNavigator, }, -- Create a tab (alternative to Ctrl-Shift-Tab) { key = 'c', mods = 'LEADER', action = act.SpawnTab 'CurrentPaneDomain', }, -- Rename current tab; analagous to command in tmux { key = ',', mods = 'LEADER', action = act.PromptInputLine { description = 'Enter new name for tab', action = wezterm.action_callback( function(window, pane, line) -- luacheck: ignore 212 if line then window:active_tab():set_title(line) end end ), }, }, -- Move to next/previous TAB { key = 'n', mods = 'LEADER', action = act.ActivateTabRelative(1), }, { key = 'p', mods = 'LEADER', action = act.ActivateTabRelative(-1), }, -- Close tab { key = '&', mods = 'LEADER|SHIFT', action = act.CloseCurrentTab{ confirm = true }, }, -- ---------------------------------------------------------------- -- PANES -- -- These are great and get me most of the way to replacing tmux -- entirely, particularly as you can use "wezterm ssh" to ssh to another -- server, and still retain Wezterm as your terminal there. -- -- Note that these only define creating splits, relative motion -- (next/previous), zooming, swapping, and killing panes; actual directional -- motions between panes or resizing them are handled by smart splits. -- ---------------------------------------------------------------- -- Vertical split { -- | key = '|', mods = 'LEADER|SHIFT', action = act.SplitPane { direction = 'Right', size = { Percent = 50 }, }, }, -- Horizontal split { -- - key = '-', mods = 'LEADER', action = act.SplitPane { direction = 'Down', size = { Percent = 50 }, }, }, -- Close/kill active pane { key = 'x', mods = 'LEADER', action = act.CloseCurrentPane { confirm = true }, }, -- Swap active pane with another one { key = '{', mods = 'LEADER|SHIFT', action = act.PaneSelect { mode = "SwapWithActiveKeepFocus" }, }, -- Zoom current pane (toggle) { key = 'z', mods = 'LEADER', action = act.TogglePaneZoomState, }, { key = 'f', mods = 'ALT', action = act.TogglePaneZoomState, }, -- Move to next/previous pane { key = ';', mods = 'LEADER', action = act.ActivatePaneDirection('Prev'), }, { key = 'o', mods = 'LEADER', action = act.ActivatePaneDirection('Next'), }, -- ---------------------------------------------------------------- -- Workspaces -- -- These are roughly equivalent to tmux sessions. -- ---------------------------------------------------------------- -- Attach to muxer { key = 'a', mods = 'LEADER', action = act.AttachDomain 'unix', }, -- Detach from muxer { key = 'd', mods = 'LEADER', action = act.DetachDomain { DomainName = 'unix' }, }, -- Show list of workspaces { key = 's', mods = 'LEADER', action = act.ShowLauncherArgs { flags = 'WORKSPACES' }, }, -- Rename current session; analagous to command in tmux { key = '$', mods = 'LEADER|SHIFT', action = act.PromptInputLine { description = 'Enter new name for session', action = wezterm.action_callback( function(window, pane, line) -- luacheck: ignore 212 if line then mux.rename_workspace( window:mux_window():get_workspace(), line ) end end ), }, }, } -- -------------------------------------------------------------------- -- Smart splits -- -- See https://github.com/mrjones2014/smart-splits.nvim -- -- Allows moving and resizing panes easily, as well as navigation between -- wezterm and nvim panes -- -------------------------------------------------------------------- config.keys = merge.all(config.keys, smart_splits.keys) -- -------------------------------------------------------------------- -- resurrect.wezterm -- -- See https://github.com/MLFlexer/resurrect.wezterm -- See resurrect.lua -- -------------------------------------------------------------------- config.keys = merge.all(config.keys, resurrect.keys) -- Powerline for tab bar require 'powerline' -- Tab status require 'tab-status' -- Plugin management -- Automatically update plugins -- wezterm.plugin.update_all() -- and finally, return the configuration to wezterm return config