root
1.
WezTerm
❱
1.1.
Features
1.2.
Scrollback
1.3.
Quick Select Mode
1.4.
Copy Mode
1.5.
Hyperlinks
1.6.
Shell Integration
1.7.
iTerm Image Protocol
1.8.
SSH
1.9.
Serial Ports & Arduino
1.10.
Multiplexing
2.
Configuration
❱
2.1.
Colors & Appearance
2.2.
Launching Programs
2.3.
Fonts
2.4.
Font Shaping
2.5.
Keyboard Concepts
2.6.
Key Binding
2.7.
Key Tables
2.8.
Default Key Assignments
2.9.
Keyboard Encoding
2.10.
Mouse Binding
2.11.
Color Schemes
❱
2.11.1.
3
2.11.2.
a
2.11.3.
b
2.11.4.
c
2.11.5.
d
2.11.6.
e
2.11.7.
f
2.11.8.
g
2.11.9.
h
2.11.10.
i
2.11.11.
j
2.11.12.
k
2.11.13.
l
2.11.14.
m
2.11.15.
n
2.11.16.
o
2.11.17.
p
2.11.18.
q
2.11.19.
r
2.11.20.
s
2.11.21.
t
2.11.22.
u
2.11.23.
v
2.11.24.
w
2.11.25.
x
2.11.26.
y
2.11.27.
z
2.12.
Recipes
❱
2.12.1.
Passing Data from a pane to Lua
2.12.2.
Workspaces / Sessions
3.
Lua Reference
❱
3.1.
module: wezterm
❱
3.1.1.
GLOBAL
3.1.2.
action
3.1.3.
action_callback
3.1.4.
add_to_config_reload_watch_list
3.1.5.
background_child_process
3.1.6.
battery_info
3.1.7.
column_width
3.1.8.
config_builder
3.1.9.
config_dir
3.1.10.
config_file
3.1.11.
default_hyperlink_rules
3.1.12.
default_ssh_domains
3.1.13.
default_wsl_domains
3.1.14.
emit
3.1.15.
enumerate_ssh_hosts
3.1.16.
executable_dir
3.1.17.
font
3.1.18.
font_with_fallback
3.1.19.
format
3.1.20.
get_builtin_color_schemes
3.1.21.
glob
3.1.22.
gradient_colors
3.1.23.
has_action
3.1.24.
home_dir
3.1.25.
hostname
3.1.26.
json_encode
3.1.27.
json_parse
3.1.28.
log_error
3.1.29.
log_info
3.1.30.
log_warn
3.1.31.
nerdfonts
3.1.32.
on
3.1.33.
open_with
3.1.34.
pad_left
3.1.35.
pad_right
3.1.36.
permute_any_mods
3.1.37.
permute_any_or_no_mods
3.1.38.
read_dir
3.1.39.
reload_configuration
3.1.40.
run_child_process
3.1.41.
running_under_wsl
3.1.42.
shell_join_args
3.1.43.
shell_quote_arg
3.1.44.
shell_split
3.1.45.
sleep_ms
3.1.46.
split_by_newlines
3.1.47.
strftime
3.1.48.
strftime_utc
3.1.49.
target_triple
3.1.50.
truncate_left
3.1.51.
truncate_right
3.1.52.
utf16_to_utf8
3.1.53.
version
3.2.
module: wezterm.color
❱
3.2.1.
extract_colors_from_image
3.2.2.
from_hsla
3.2.3.
get_builtin_schemes
3.2.4.
get_default_colors
3.2.5.
gradient
3.2.6.
load_base16_scheme
3.2.7.
load_scheme
3.2.8.
load_terminal_sexy_scheme
3.2.9.
parse
3.2.10.
save_scheme
3.3.
module: wezterm.gui
❱
3.3.1.
default_key_tables
3.3.2.
default_keys
3.3.3.
enumerate_gpus
3.3.4.
get_appearance
3.3.5.
gui_window_for_mux_window
3.3.6.
gui_windows
3.3.7.
screens
3.4.
module: wezterm.mux
❱
3.4.1.
all_domains
3.4.2.
all_windows
3.4.3.
get_active_workspace
3.4.4.
get_domain
3.4.5.
get_pane
3.4.6.
get_tab
3.4.7.
get_window
3.4.8.
get_workspace_names
3.4.9.
rename_workspace
3.4.10.
set_active_workspace
3.4.11.
set_default_domain
3.4.12.
spawn_window
3.5.
module: wezterm.procinfo
❱
3.5.1.
current_working_dir_for_pid
3.5.2.
executable_path_for_pid
3.5.3.
get_info_for_pid
3.5.4.
pid
3.6.
module: wezterm.time
❱
3.6.1.
call_after
3.6.2.
now
3.6.3.
parse
3.6.4.
parse_rfc3339
3.7.
struct: Config
❱
3.7.1.
adjust_window_size_when_changing_font_size
3.7.2.
allow_square_glyphs_to_overflow_width
3.7.3.
allow_win32_input_mode
3.7.4.
alternate_buffer_wheel_scroll_speed
3.7.5.
animation_fps
3.7.6.
audible_bell
3.7.7.
automatically_reload_config
3.7.8.
background
3.7.9.
bold_brightens_ansi_colors
3.7.10.
bypass_mouse_reporting_modifiers
3.7.11.
canonicalize_pasted_newlines
3.7.12.
cell_width
3.7.13.
check_for_updates
3.7.14.
clean_exit_codes
3.7.15.
color_schemes
3.7.16.
colors
3.7.17.
command_palette_bg_color
3.7.18.
command_palette_fg_color
3.7.19.
command_palette_font_size
3.7.20.
cursor_blink_ease_in
3.7.21.
cursor_blink_ease_out
3.7.22.
cursor_blink_rate
3.7.23.
cursor_thickness
3.7.24.
custom_block_glyphs
3.7.25.
daemon_options
3.7.26.
debug_key_events
3.7.27.
default_cursor_style
3.7.28.
default_cwd
3.7.29.
default_domain
3.7.30.
default_gui_startup_args
3.7.31.
default_prog
3.7.32.
default_workspace
3.7.33.
detect_password_input
3.7.34.
disable_default_mouse_bindings
3.7.35.
disable_default_quick_select_patterns
3.7.36.
display_pixel_geometry
3.7.37.
dpi
3.7.38.
enable_csi_u_key_encoding
3.7.39.
enable_kitty_keyboard
3.7.40.
enable_scroll_bar
3.7.41.
enable_tab_bar
3.7.42.
enable_wayland
3.7.43.
exit_behavior
3.7.44.
font
3.7.45.
font_antialias
3.7.46.
font_dirs
3.7.47.
font_hinting
3.7.48.
font_locator
3.7.49.
font_rasterizer
3.7.50.
font_rules
3.7.51.
font_shaper
3.7.52.
font_size
3.7.53.
force_reverse_video_cursor
3.7.54.
foreground_text_hsb
3.7.55.
freetype_interpreter_version
3.7.56.
freetype_load_flags
3.7.57.
freetype_load_target
3.7.58.
freetype_pcf_long_family_names
3.7.59.
freetype_render_target
3.7.60.
front_end
3.7.61.
harfbuzz_features
3.7.62.
hide_mouse_cursor_when_typing
3.7.63.
hide_tab_bar_if_only_one_tab
3.7.64.
hyperlink_rules
3.7.65.
ime_preedit_rendering
3.7.66.
initial_cols
3.7.67.
initial_rows
3.7.68.
integrated_title_button_alignment
3.7.69.
integrated_title_button_color
3.7.70.
integrated_title_button_style
3.7.71.
integrated_title_buttons
3.7.72.
key_map_preference
3.7.73.
key_tables
3.7.74.
launch_menu
3.7.75.
line_height
3.7.76.
log_unknown_escape_sequences
3.7.77.
macos_forward_to_ime_modifier_mask
3.7.78.
macos_window_background_blur
3.7.79.
max_fps
3.7.80.
min_scroll_bar_height
3.7.81.
mouse_wheel_scrolls_tabs
3.7.82.
mux_env_remove
3.7.83.
native_macos_fullscreen_mode
3.7.84.
normalize_output_to_unicode_nfc
3.7.85.
pane_focus_follows_mouse
3.7.86.
prefer_egl
3.7.87.
quick_select_alphabet
3.7.88.
quick_select_patterns
3.7.89.
quit_when_all_windows_are_closed
3.7.90.
quote_dropped_files
3.7.91.
scroll_to_bottom_on_input
3.7.92.
scrollback_lines
3.7.93.
selection_word_boundary
3.7.94.
serial_ports
3.7.95.
set_environment_variables
3.7.96.
show_new_tab_button_in_tab_bar
3.7.97.
show_tab_index_in_tab_bar
3.7.98.
show_tabs_in_tab_bar
3.7.99.
show_update_window
3.7.100.
skip_close_confirmation_for_processes_named
3.7.101.
ssh_backend
3.7.102.
ssh_domains
3.7.103.
status_update_interval
3.7.104.
strikethrough_position
3.7.105.
swallow_mouse_click_on_pane_focus
3.7.106.
swallow_mouse_click_on_window_focus
3.7.107.
swap_backspace_and_delete
3.7.108.
switch_to_last_active_tab_when_closing_tab
3.7.109.
tab_and_split_indices_are_zero_based
3.7.110.
tab_bar_at_bottom
3.7.111.
tab_bar_style
3.7.112.
tab_max_width
3.7.113.
term
3.7.114.
text_blink_ease_in
3.7.115.
text_blink_ease_out
3.7.116.
text_blink_rapid_ease_in
3.7.117.
text_blink_rapid_ease_out
3.7.118.
text_blink_rate
3.7.119.
text_blink_rate_rapid
3.7.120.
tls_clients
3.7.121.
tls_servers
3.7.122.
treat_east_asian_ambiguous_width_as_wide
3.7.123.
treat_left_ctrlalt_as_altgr
3.7.124.
ulimit_nofile
3.7.125.
ulimit_nproc
3.7.126.
underline_position
3.7.127.
underline_thickness
3.7.128.
unicode_version
3.7.129.
unix_domains
3.7.130.
unzoom_on_switch_pane
3.7.131.
use_cap_height_to_scale_fallback_fonts
3.7.132.
use_fancy_tab_bar
3.7.133.
use_ime
3.7.134.
use_resize_increments
3.7.135.
visual_bell
3.7.136.
warn_about_missing_glyphs
3.7.137.
webgpu_force_fallback_adapter
3.7.138.
webgpu_power_preference
3.7.139.
webgpu_preferred_adapter
3.7.140.
window_background_gradient
3.7.141.
window_close_confirmation
3.7.142.
window_decorations
3.7.143.
window_frame
3.7.144.
window_padding
3.7.145.
wsl_domains
3.7.146.
xim_im_name
3.8.
enum: KeyAssignment
❱
3.8.1.
ActivateCommandPalette
3.8.2.
ActivateCopyMode
3.8.3.
ActivateKeyTable
3.8.4.
ActivateLastTab
3.8.5.
ActivatePaneByIndex
3.8.6.
ActivatePaneDirection
3.8.7.
ActivateTab
3.8.8.
ActivateTabRelative
3.8.9.
ActivateTabRelativeNoWrap
3.8.10.
ActivateWindow
3.8.11.
ActivateWindowRelative
3.8.12.
ActivateWindowRelativeNoWrap
3.8.13.
AdjustPaneSize
3.8.14.
AttachDomain
3.8.15.
CharSelect
3.8.16.
ClearKeyTableStack
3.8.17.
ClearScrollback
3.8.18.
ClearSelection
3.8.19.
CloseCurrentPane
3.8.20.
CloseCurrentTab
3.8.21.
CompleteSelection
3.8.22.
CompleteSelectionOrOpenLinkAtMouseCursor
3.8.23.
Copy
3.8.24.
CopyTo
3.8.25.
DecreaseFontSize
3.8.26.
DetachDomain
3.8.27.
DisableDefaultAssignment
3.8.28.
EmitEvent
3.8.29.
ExtendSelectionToMouseCursor
3.8.30.
Hide
3.8.31.
HideApplication
3.8.32.
IncreaseFontSize
3.8.33.
InputSelector
3.8.34.
MoveTab
3.8.35.
MoveTabRelative
3.8.36.
Multiple
3.8.37.
Nop
3.8.38.
OpenLinkAtMouseCursor
3.8.39.
PaneSelect
3.8.40.
Paste
3.8.41.
PasteFrom
3.8.42.
PastePrimarySelection
3.8.43.
PopKeyTable
3.8.44.
PromptInputLine
3.8.45.
QuickSelect
3.8.46.
QuickSelectArgs
3.8.47.
QuitApplication
3.8.48.
ReloadConfiguration
3.8.49.
ResetFontAndWindowSize
3.8.50.
ResetFontSize
3.8.51.
ResetTerminal
3.8.52.
RotatePanes
3.8.53.
ScrollByCurrentEventWheelDelta
3.8.54.
ScrollByLine
3.8.55.
ScrollByPage
3.8.56.
ScrollToBottom
3.8.57.
ScrollToPrompt
3.8.58.
ScrollToTop
3.8.59.
Search
3.8.60.
SelectTextAtMouseCursor
3.8.61.
SendKey
3.8.62.
SendString
3.8.63.
SetPaneZoomState
3.8.64.
Show
3.8.65.
ShowDebugOverlay
3.8.66.
ShowLauncher
3.8.67.
ShowLauncherArgs
3.8.68.
ShowTabNavigator
3.8.69.
SpawnCommandInNewTab
3.8.70.
SpawnCommandInNewWindow
3.8.71.
SpawnTab
3.8.72.
SpawnWindow
3.8.73.
SplitHorizontal
3.8.74.
SplitPane
3.8.75.
SplitVertical
3.8.76.
StartWindowDrag
3.8.77.
SwitchToWorkspace
3.8.78.
SwitchWorkspaceRelative
3.8.79.
ToggleFullScreen
3.8.80.
TogglePaneZoomState
3.9.
enum: CopyModeAssignment
❱
3.9.1.
AcceptPattern
3.9.2.
ClearPattern
3.9.3.
ClearSelectionMode
3.9.4.
Close
3.9.5.
CycleMatchType
3.9.6.
EditPattern
3.9.7.
MoveBackwardSemanticZone
3.9.8.
MoveBackwardSemanticZoneOfType
3.9.9.
MoveBackwardWord
3.9.10.
MoveDown
3.9.11.
MoveForwardSemanticZone
3.9.12.
MoveForwardSemanticZoneOfType
3.9.13.
MoveForwardWord
3.9.14.
MoveForwardWordEnd
3.9.15.
MoveLeft
3.9.16.
MoveRight
3.9.17.
MoveToEndOfLineContent
3.9.18.
MoveToScrollbackBottom
3.9.19.
MoveToScrollbackTop
3.9.20.
MoveToSelectionOtherEnd
3.9.21.
MoveToSelectionOtherEndHoriz
3.9.22.
MoveToStartOfLine
3.9.23.
MoveToStartOfLineContent
3.9.24.
MoveToStartOfNextLine
3.9.25.
MoveToViewportBottom
3.9.26.
MoveToViewportMiddle
3.9.27.
MoveToViewportTop
3.9.28.
MoveUp
3.9.29.
NextMatch
3.9.30.
NextMatchPage
3.9.31.
PriorMatch
3.9.32.
PriorMatchPage
3.9.33.
SetSelectionMode
3.10.
object: Color
❱
3.10.1.
adjust_hue_fixed
3.10.2.
adjust_hue_fixed_ryb
3.10.3.
complement
3.10.4.
complement_ryb
3.10.5.
contrast_ratio
3.10.6.
darken
3.10.7.
darken_fixed
3.10.8.
delta_e
3.10.9.
desaturate
3.10.10.
desaturate_fixed
3.10.11.
hsla
3.10.12.
laba
3.10.13.
lighten
3.10.14.
lighten_fixed
3.10.15.
linear_rgba
3.10.16.
saturate
3.10.17.
saturate_fixed
3.10.18.
square
3.10.19.
srgb_u8
3.10.20.
triad
3.11.
object: ExecDomain
3.12.
object: LocalProcessInfo
3.13.
object: MuxDomain
❱
3.13.1.
attach
3.13.2.
detach
3.13.3.
domain_id
3.13.4.
has_any_panes
3.13.5.
is_spawnable
3.13.6.
label
3.13.7.
name
3.13.8.
state
3.14.
object: MuxWindow
❱
3.14.1.
active_pane
3.14.2.
active_tab
3.14.3.
get_title
3.14.4.
get_workspace
3.14.5.
gui_window
3.14.6.
set_title
3.14.7.
set_workspace
3.14.8.
spawn_tab
3.14.9.
tabs
3.14.10.
tabs_with_info
3.14.11.
window_id
3.15.
object: MuxTab
❱
3.15.1.
activate
3.15.2.
active_pane
3.15.3.
get_pane_direction
3.15.4.
get_size
3.15.5.
get_title
3.15.6.
panes
3.15.7.
panes_with_info
3.15.8.
rotate_clockwise
3.15.9.
rotate_counter_clockwise
3.15.10.
set_title
3.15.11.
set_zoomed
3.15.12.
tab_id
3.15.13.
window
3.16.
object: PaneInformation
3.17.
object: TabInformation
3.18.
object: SshDomain
3.19.
object: SpawnCommand
3.20.
object: Time
❱
3.20.1.
format
3.20.2.
format_utc
3.20.3.
sun_times
3.21.
object: TlsDomainClient
3.22.
object: TlsDomainServer
3.23.
object: Pane
❱
3.23.1.
activate
3.23.2.
get_current_working_dir
3.23.3.
get_cursor_position
3.23.4.
get_dimensions
3.23.5.
get_domain_name
3.23.6.
get_foreground_process_info
3.23.7.
get_foreground_process_name
3.23.8.
get_lines_as_text
3.23.9.
get_logical_lines_as_text
3.23.10.
get_metadata
3.23.11.
get_semantic_zone_at
3.23.12.
get_semantic_zones
3.23.13.
get_text_from_region
3.23.14.
get_text_from_semantic_zone
3.23.15.
get_title
3.23.16.
get_tty_name
3.23.17.
get_user_vars
3.23.18.
has_unseen_output
3.23.19.
inject_output
3.23.20.
is_alt_screen_active
3.23.21.
move_to_new_tab
3.23.22.
move_to_new_window
3.23.23.
mux_pane
3.23.24.
pane_id
3.23.25.
paste
3.23.26.
send_paste
3.23.27.
send_text
3.23.28.
split
3.23.29.
tab
3.23.30.
window
3.24.
object: Window
❱
3.24.1.
active_key_table
3.24.2.
active_pane
3.24.3.
active_tab
3.24.4.
active_workspace
3.24.5.
composition_status
3.24.6.
copy_to_clipboard
3.24.7.
current_event
3.24.8.
effective_config
3.24.9.
focus
3.24.10.
get_appearance
3.24.11.
get_config_overrides
3.24.12.
get_dimensions
3.24.13.
get_selection_escapes_for_pane
3.24.14.
get_selection_text_for_pane
3.24.15.
is_focused
3.24.16.
leader_is_active
3.24.17.
maximize
3.24.18.
mux_window
3.24.19.
perform_action
3.24.20.
restore
3.24.21.
set_config_overrides
3.24.22.
set_inner_size
3.24.23.
set_left_status
3.24.24.
set_position
3.24.25.
set_right_status
3.24.26.
toast_notification
3.24.27.
toggle_fullscreen
3.24.28.
window_id
3.25.
object: WslDomain
3.26.
events: Gui
❱
3.26.1.
gui-attached
3.26.2.
gui-startup
3.27.
events: Multiplexer
❱
3.27.1.
mux-is-process-stateful
3.27.2.
mux-startup
3.28.
events: Window
❱
3.28.1.
bell
3.28.2.
format-tab-title
3.28.3.
format-window-title
3.28.4.
new-tab-button-click
3.28.5.
open-uri
3.28.6.
update-right-status
3.28.7.
update-status
3.28.8.
user-var-changed
3.28.9.
window-config-reloaded
3.28.10.
window-focus-changed
3.28.11.
window-resized
4.
CLI Reference
❱
4.1.
wezterm cli
❱
4.1.1.
activate-pane-direction
4.1.2.
activate-pane
4.1.3.
activate-tab
4.1.4.
get-pane-direction
4.1.5.
get-text
4.1.6.
kill-pane
4.1.7.
list-clients
4.1.8.
list
4.1.9.
move-pane-to-new-tab
4.1.10.
rename-workspace
4.1.11.
send-text
4.1.12.
set-tab-title
4.1.13.
set-window-title
4.1.14.
spawn
4.1.15.
split-pane
4.2.
wezterm connect
4.3.
wezterm imgcat
4.4.
wezterm ls-fonts
4.5.
wezterm record
4.6.
wezterm replay
4.7.
wezterm serial
4.8.
wezterm set-working-directory
4.9.
wezterm show-keys
4.10.
wezterm ssh
4.11.
wezterm start
4.12.
Escape Sequences
4.13.
What is a Terminal?
4.14.
Troubleshooting
4.15.
F.A.Q.
4.16.
Getting Help
4.17.
Contributing
5.
Change Log
6.
Sponsor
Light
Rust
Coal
Navy
Ayu
Wez's Terminal Emulator
Events emitted by the Multiplexer
The following events can be handled using
wezterm.on
:
mux-is-process-stateful
mux-startup