wezterm
1.
Install
❱
1.1.
Windows
1.2.
macOS
1.3.
Linux
1.4.
FreeBSD
1.5.
Build from source
2.
Features
3.
Change Log
4.
Configuration
❱
4.1.
Launching Programs
4.2.
Fonts
4.3.
Font Shaping
4.4.
Keyboard Concepts
4.5.
Key Binding
4.6.
Key Tables
4.7.
Default Key Assignments
4.8.
Keyboard Encoding
4.9.
Mouse Binding
4.10.
Colors & Appearance
4.11.
Color Schemes
❱
4.11.1.
3
4.11.2.
a
4.11.3.
b
4.11.4.
c
4.11.5.
d
4.11.6.
e
4.11.7.
f
4.11.8.
g
4.11.9.
h
4.11.10.
i
4.11.11.
j
4.11.12.
k
4.11.13.
l
4.11.14.
m
4.11.15.
n
4.11.16.
o
4.11.17.
p
4.11.18.
q
4.11.19.
r
4.11.20.
s
4.11.21.
t
4.11.22.
u
4.11.23.
v
4.11.24.
w
4.11.25.
x
4.11.26.
y
4.11.27.
z
5.
Scrollback
6.
Quick Select Mode
7.
Copy Mode
8.
Hyperlinks
9.
Shell Integration
10.
iTerm Image Protocol
11.
SSH
12.
Serial Ports & Arduino
13.
Multiplexing
14.
Escape Sequences
15.
F.A.Q.
16.
Getting Help
17.
Contributing
18.
CLI Reference
❱
18.1.
cli
❱
18.1.1.
activate-pane-direction
18.1.2.
list-clients
18.1.3.
list
18.1.4.
move-pane-to-new-tab
18.1.5.
send-text
18.1.6.
spawn
18.1.7.
split-pane
18.2.
show-keys
19.
Lua Reference
❱
19.1.
module: wezterm
❱
19.1.1.
GLOBAL
19.1.2.
action
19.1.3.
action_callback
19.1.4.
add_to_config_reload_watch_list
19.1.5.
background_child_process
19.1.6.
battery_info
19.1.7.
column_width
19.1.8.
config_dir
19.1.9.
config_file
19.1.10.
default_wsl_domains
19.1.11.
emit
19.1.12.
enumerate_ssh_hosts
19.1.13.
executable_dir
19.1.14.
font
19.1.15.
font_with_fallback
19.1.16.
format
19.1.17.
get_builtin_color_schemes
19.1.18.
glob
19.1.19.
gradient_colors
19.1.20.
home_dir
19.1.21.
hostname
19.1.22.
json_encode
19.1.23.
json_parse
19.1.24.
log_error
19.1.25.
log_info
19.1.26.
log_warn
19.1.27.
nerdfonts
19.1.28.
on
19.1.29.
open_with
19.1.30.
pad_left
19.1.31.
pad_right
19.1.32.
permute_any_mods
19.1.33.
permute_any_or_no_mods
19.1.34.
read_dir
19.1.35.
reload_configuration
19.1.36.
run_child_process
19.1.37.
running_under_wsl
19.1.38.
shell_join_args
19.1.39.
shell_quote_arg
19.1.40.
shell_split
19.1.41.
sleep_ms
19.1.42.
split_by_newlines
19.1.43.
strftime
19.1.44.
strftime_utc
19.1.45.
target_triple
19.1.46.
truncate_left
19.1.47.
truncate_right
19.1.48.
utf16_to_utf8
19.1.49.
version
19.2.
module: wezterm.color
❱
19.2.1.
extract_colors_from_image
19.2.2.
from_hsla
19.2.3.
get_builtin_schemes
19.2.4.
get_default_colors
19.2.5.
gradient
19.2.6.
load_base16_scheme
19.2.7.
load_scheme
19.2.8.
load_terminal_sexy_scheme
19.2.9.
parse
19.2.10.
save_scheme
19.3.
module: wezterm.gui
❱
19.3.1.
default_key_tables
19.3.2.
default_keys
19.3.3.
get_appearance
19.3.4.
gui_window_for_mux_window
19.3.5.
screens
19.4.
module: wezterm.mux
❱
19.4.1.
all_windows
19.4.2.
get_active_workspace
19.4.3.
get_pane
19.4.4.
get_tab
19.4.5.
get_window
19.4.6.
get_workspace_names
19.4.7.
set_active_workspace
19.4.8.
spawn_window
19.5.
module: wezterm.procinfo
❱
19.5.1.
current_working_dir_for_pid
19.5.2.
executable_path_for_pid
19.5.3.
get_info_for_pid
19.5.4.
pid
19.6.
module: wezterm.time
❱
19.6.1.
call_after
19.6.2.
now
19.6.3.
parse
19.6.4.
parse_rfc3339
19.7.
struct: Config
❱
19.7.1.
adjust_window_size_when_changing_font_size
19.7.2.
allow_square_glyphs_to_overflow_width
19.7.3.
allow_win32_input_mode
19.7.4.
alternate_buffer_wheel_scroll_speed
19.7.5.
animation_fps
19.7.6.
audible_bell
19.7.7.
automatically_reload_config
19.7.8.
background
19.7.9.
bold_brightens_ansi_colors
19.7.10.
bypass_mouse_reporting_modifiers
19.7.11.
canonicalize_pasted_newlines
19.7.12.
cell_width
19.7.13.
check_for_updates
19.7.14.
clean_exit_codes
19.7.15.
color_schemes
19.7.16.
colors
19.7.17.
cursor_blink_ease_in
19.7.18.
cursor_blink_ease_out
19.7.19.
cursor_blink_rate
19.7.20.
cursor_thickness
19.7.21.
custom_block_glyphs
19.7.22.
daemon_options
19.7.23.
debug_key_events
19.7.24.
default_cursor_style
19.7.25.
default_cwd
19.7.26.
default_domain
19.7.27.
default_gui_startup_args
19.7.28.
default_prog
19.7.29.
default_workspace
19.7.30.
detect_password_input
19.7.31.
disable_default_mouse_bindings
19.7.32.
disable_default_quick_select_patterns
19.7.33.
dpi
19.7.34.
enable_csi_u_key_encoding
19.7.35.
enable_kitty_keyboard
19.7.36.
enable_scroll_bar
19.7.37.
enable_tab_bar
19.7.38.
enable_wayland
19.7.39.
exit_behavior
19.7.40.
font
19.7.41.
font_antialias
19.7.42.
font_dirs
19.7.43.
font_hinting
19.7.44.
font_locator
19.7.45.
font_rasterizer
19.7.46.
font_rules
19.7.47.
font_shaper
19.7.48.
font_size
19.7.49.
force_reverse_video_cursor
19.7.50.
foreground_text_hsb
19.7.51.
freetype_interpreter_version
19.7.52.
freetype_load_flags
19.7.53.
freetype_load_target
19.7.54.
freetype_pcf_long_family_names
19.7.55.
freetype_render_target
19.7.56.
front_end
19.7.57.
harfbuzz_features
19.7.58.
hide_tab_bar_if_only_one_tab
19.7.59.
hyperlink_rules
19.7.60.
ime_preedit_rendering
19.7.61.
initial_cols
19.7.62.
initial_rows
19.7.63.
key_map_preference
19.7.64.
key_tables
19.7.65.
launch_menu
19.7.66.
line_height
19.7.67.
max_fps
19.7.68.
min_scroll_bar_height
19.7.69.
mux_env_remove
19.7.70.
native_macos_fullscreen_mode
19.7.71.
normalize_output_to_unicode_nfc
19.7.72.
pane_focus_follows_mouse
19.7.73.
prefer_egl
19.7.74.
quick_select_alphabet
19.7.75.
quick_select_patterns
19.7.76.
quote_dropped_files
19.7.77.
scroll_to_bottom_on_input
19.7.78.
scrollback_lines
19.7.79.
selection_word_boundary
19.7.80.
set_environment_variables
19.7.81.
show_new_tab_button_in_tab_bar
19.7.82.
show_tab_index_in_tab_bar
19.7.83.
show_tabs_in_tab_bar
19.7.84.
show_update_window
19.7.85.
skip_close_confirmation_for_processes_named
19.7.86.
ssh_backend
19.7.87.
ssh_domains
19.7.88.
status_update_interval
19.7.89.
strikethrough_position
19.7.90.
swallow_mouse_click_on_pane_focus
19.7.91.
swallow_mouse_click_on_window_focus
19.7.92.
swap_backspace_and_delete
19.7.93.
switch_to_last_active_tab_when_closing_tab
19.7.94.
tab_and_split_indices_are_zero_based
19.7.95.
tab_bar_at_bottom
19.7.96.
tab_bar_style
19.7.97.
tab_max_width
19.7.98.
term
19.7.99.
text_blink_ease_in
19.7.100.
text_blink_ease_out
19.7.101.
text_blink_rapid_ease_in
19.7.102.
text_blink_rapid_ease_out
19.7.103.
text_blink_rate
19.7.104.
text_blink_rate_rapid
19.7.105.
tls_clients
19.7.106.
tls_servers
19.7.107.
treat_east_asian_ambiguous_width_as_wide
19.7.108.
treat_left_ctrlalt_as_altgr
19.7.109.
underline_position
19.7.110.
underline_thickness
19.7.111.
unicode_version
19.7.112.
unix_domains
19.7.113.
unzoom_on_switch_pane
19.7.114.
use_cap_height_to_scale_fallback_fonts
19.7.115.
use_fancy_tab_bar
19.7.116.
use_ime
19.7.117.
use_resize_increments
19.7.118.
visual_bell
19.7.119.
warn_about_missing_glyphs
19.7.120.
window_background_gradient
19.7.121.
window_close_confirmation
19.7.122.
window_decorations
19.7.123.
window_frame
19.7.124.
window_padding
19.7.125.
wsl_domains
19.7.126.
xim_im_name
19.8.
enum: KeyAssignment
❱
19.8.1.
ActivateCopyMode
19.8.2.
ActivateKeyTable
19.8.3.
ActivateLastTab
19.8.4.
ActivatePaneByIndex
19.8.5.
ActivatePaneDirection
19.8.6.
ActivateTab
19.8.7.
ActivateTabRelative
19.8.8.
ActivateTabRelativeNoWrap
19.8.9.
AdjustPaneSize
19.8.10.
AttachDomain
19.8.11.
CharSelect
19.8.12.
ClearKeyTableStack
19.8.13.
ClearScrollback
19.8.14.
ClearSelection
19.8.15.
CloseCurrentPane
19.8.16.
CloseCurrentTab
19.8.17.
CompleteSelection
19.8.18.
CompleteSelectionOrOpenLinkAtMouseCursor
19.8.19.
Copy
19.8.20.
CopyTo
19.8.21.
DecreaseFontSize
19.8.22.
DetachDomain
19.8.23.
DisableDefaultAssignment
19.8.24.
EmitEvent
19.8.25.
ExtendSelectionToMouseCursor
19.8.26.
Hide
19.8.27.
HideApplication
19.8.28.
IncreaseFontSize
19.8.29.
MoveTab
19.8.30.
MoveTabRelative
19.8.31.
Multiple
19.8.32.
Nop
19.8.33.
OpenLinkAtMouseCursor
19.8.34.
PaneSelect
19.8.35.
Paste
19.8.36.
PasteFrom
19.8.37.
PastePrimarySelection
19.8.38.
PopKeyTable
19.8.39.
QuickSelect
19.8.40.
QuickSelectArgs
19.8.41.
QuitApplication
19.8.42.
ReloadConfiguration
19.8.43.
ResetFontAndWindowSize
19.8.44.
ResetFontSize
19.8.45.
ResetTerminal
19.8.46.
RotatePanes
19.8.47.
ScrollByCurrentEventWheelDelta
19.8.48.
ScrollByLine
19.8.49.
ScrollByPage
19.8.50.
ScrollToBottom
19.8.51.
ScrollToPrompt
19.8.52.
ScrollToTop
19.8.53.
Search
19.8.54.
SelectTextAtMouseCursor
19.8.55.
SendKey
19.8.56.
SendString
19.8.57.
SetPaneZoomState
19.8.58.
Show
19.8.59.
ShowDebugOverlay
19.8.60.
ShowLauncher
19.8.61.
ShowLauncherArgs
19.8.62.
ShowTabNavigator
19.8.63.
SpawnCommandInNewTab
19.8.64.
SpawnCommandInNewWindow
19.8.65.
SpawnTab
19.8.66.
SpawnWindow
19.8.67.
SplitHorizontal
19.8.68.
SplitPane
19.8.69.
SplitVertical
19.8.70.
StartWindowDrag
19.8.71.
SwitchToWorkspace
19.8.72.
SwitchWorkspaceRelative
19.8.73.
ToggleFullScreen
19.8.74.
TogglePaneZoomState
19.9.
enum: CopyModeAssignment
❱
19.9.1.
AcceptPattern
19.9.2.
ClearPattern
19.9.3.
ClearSelectionMode
19.9.4.
Close
19.9.5.
CycleMatchType
19.9.6.
EditPattern
19.9.7.
MoveBackwardSemanticZone
19.9.8.
MoveBackwardSemanticZoneOfType
19.9.9.
MoveBackwardWord
19.9.10.
MoveDown
19.9.11.
MoveForwardSemanticZone
19.9.12.
MoveForwardSemanticZoneOfType
19.9.13.
MoveForwardWord
19.9.14.
MoveLeft
19.9.15.
MoveRight
19.9.16.
MoveToEndOfLineContent
19.9.17.
MoveToScrollbackBottom
19.9.18.
MoveToScrollbackTop
19.9.19.
MoveToSelectionOtherEnd
19.9.20.
MoveToSelectionOtherEndHoriz
19.9.21.
MoveToStartOfLine
19.9.22.
MoveToStartOfLineContent
19.9.23.
MoveToStartOfNextLine
19.9.24.
MoveToViewportBottom
19.9.25.
MoveToViewportMiddle
19.9.26.
MoveToViewportTop
19.9.27.
MoveUp
19.9.28.
NextMatch
19.9.29.
NextMatchPage
19.9.30.
PriorMatch
19.9.31.
PriorMatchPage
19.9.32.
SetSelectionMode
19.10.
object: Color
❱
19.10.1.
adjust_hue_fixed
19.10.2.
adjust_hue_fixed_ryb
19.10.3.
complement
19.10.4.
complement_ryb
19.10.5.
contrast_ratio
19.10.6.
darken
19.10.7.
darken_fixed
19.10.8.
delta_e
19.10.9.
desaturate
19.10.10.
desaturate_fixed
19.10.11.
hsla
19.10.12.
laba
19.10.13.
lighten
19.10.14.
lighten_fixed
19.10.15.
linear_rgba
19.10.16.
saturate
19.10.17.
saturate_fixed
19.10.18.
square
19.10.19.
srgb_u8
19.10.20.
triad
19.11.
object: ExecDomain
19.12.
object: LocalProcessInfo
19.13.
object: MuxWindow
❱
19.13.1.
get_title
19.13.2.
get_workspace
19.13.3.
gui_window
19.13.4.
set_title
19.13.5.
set_workspace
19.13.6.
spawn_tab
19.13.7.
tabs
19.13.8.
tabs_with_info
19.13.9.
window_id
19.14.
object: MuxTab
❱
19.14.1.
get_title
19.14.2.
panes
19.14.3.
panes_with_info
19.14.4.
set_title
19.14.5.
set_zoomed
19.14.6.
tab_id
19.14.7.
window
19.15.
object: PaneInformation
19.16.
object: TabInformation
19.17.
object: SshDomain
19.18.
object: SpawnCommand
19.19.
object: Time
❱
19.19.1.
format
19.19.2.
format_utc
19.19.3.
sun_times
19.20.
object: TlsDomainClient
19.21.
object: TlsDomainServer
19.22.
object: Pane
❱
19.22.1.
get_current_working_dir
19.22.2.
get_cursor_position
19.22.3.
get_dimensions
19.22.4.
get_domain_name
19.22.5.
get_foreground_process_info
19.22.6.
get_foreground_process_name
19.22.7.
get_lines_as_text
19.22.8.
get_logical_lines_as_text
19.22.9.
get_metadata
19.22.10.
get_title
19.22.11.
get_user_vars
19.22.12.
has_unseen_output
19.22.13.
inject_output
19.22.14.
is_alt_screen_active
19.22.15.
mux_pane
19.22.16.
pane_id
19.22.17.
paste
19.22.18.
send_paste
19.22.19.
send_text
19.22.20.
split
19.22.21.
tab
19.22.22.
window
19.23.
object: Window
❱
19.23.1.
active_key_table
19.23.2.
active_workspace
19.23.3.
composition_status
19.23.4.
copy_to_clipboard
19.23.5.
current_event
19.23.6.
effective_config
19.23.7.
get_appearance
19.23.8.
get_config_overrides
19.23.9.
get_dimensions
19.23.10.
get_selection_escapes_for_pane
19.23.11.
get_selection_text_for_pane
19.23.12.
is_focused
19.23.13.
leader_is_active
19.23.14.
maximize
19.23.15.
mux_window
19.23.16.
perform_action
19.23.17.
restore
19.23.18.
set_config_overrides
19.23.19.
set_inner_size
19.23.20.
set_left_status
19.23.21.
set_position
19.23.22.
set_right_status
19.23.23.
toast_notification
19.23.24.
toggle_fullscreen
19.23.25.
window_id
19.24.
object: WslDomain
19.25.
events: Gui
❱
19.25.1.
gui-startup
19.26.
events: Multiplexer
❱
19.26.1.
mux-is-process-stateful
19.26.2.
mux-startup
19.27.
events: Window
❱
19.27.1.
bell
19.27.2.
format-tab-title
19.27.3.
format-window-title
19.27.4.
open-uri
19.27.5.
update-right-status
19.27.6.
update-status
19.27.7.
user-var-changed
19.27.8.
window-config-reloaded
19.27.9.
window-focus-changed
19.27.10.
window-resized
Light
Rust
Coal
Navy
Ayu (default)
Wez's Terminal Emulator
Events emitted by the Multiplexer
The following events can be handled using
wezterm.on
:
mux-is-process-stateful
mux-startup