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.
Key Binding
4.5.
Mouse Binding
4.6.
Colors & Appearance
4.7.
Color Schemes
❱
4.7.1.
3
4.7.2.
a
4.7.3.
b
4.7.4.
c
4.7.5.
d
4.7.6.
e
4.7.7.
f
4.7.8.
g
4.7.9.
h
4.7.10.
i
4.7.11.
j
4.7.12.
k
4.7.13.
l
4.7.14.
m
4.7.15.
n
4.7.16.
o
4.7.17.
p
4.7.18.
r
4.7.19.
s
4.7.20.
t
4.7.21.
u
4.7.22.
v
4.7.23.
w
4.7.24.
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.
Lua Reference
❱
18.1.
module: wezterm
❱
18.1.1.
action
18.1.2.
action_callback
18.1.3.
add_to_config_reload_watch_list
18.1.4.
background_child_process
18.1.5.
battery_info
18.1.6.
column_width
18.1.7.
config_dir
18.1.8.
config_file
18.1.9.
default_wsl_domains
18.1.10.
emit
18.1.11.
executable_dir
18.1.12.
font
18.1.13.
font_with_fallback
18.1.14.
format
18.1.15.
get_builtin_color_schemes
18.1.16.
glob
18.1.17.
gradient_colors
18.1.18.
home_dir
18.1.19.
hostname
18.1.20.
log_error
18.1.21.
log_info
18.1.22.
log_warn
18.1.23.
nerdfonts
18.1.24.
on
18.1.25.
open_with
18.1.26.
pad_left
18.1.27.
pad_right
18.1.28.
permute_any_mods
18.1.29.
permute_any_or_no_mods
18.1.30.
read_dir
18.1.31.
run_child_process
18.1.32.
running_under_wsl
18.1.33.
sleep_ms
18.1.34.
split_by_newlines
18.1.35.
strftime
18.1.36.
target_triple
18.1.37.
truncate_left
18.1.38.
truncate_right
18.1.39.
utf16_to_utf8
18.1.40.
version
18.2.
struct: Config
❱
18.2.1.
adjust_window_size_when_changing_font_size
18.2.2.
allow_square_glyphs_to_overflow_width
18.2.3.
alternate_buffer_wheel_scroll_speed
18.2.4.
audible_bell
18.2.5.
automatically_reload_config
18.2.6.
bold_brightens_ansi_colors
18.2.7.
bypass_mouse_reporting_modifiers
18.2.8.
canonicalize_pasted_newlines
18.2.9.
check_for_updates
18.2.10.
color_schemes
18.2.11.
colors
18.2.12.
cursor_blink_rate
18.2.13.
custom_block_glyphs
18.2.14.
daemon_options
18.2.15.
debug_key_events
18.2.16.
default_cursor_style
18.2.17.
default_cwd
18.2.18.
default_domain
18.2.19.
default_gui_startup_args
18.2.20.
default_prog
18.2.21.
default_workspace
18.2.22.
disable_default_quick_select_patterns
18.2.23.
dpi
18.2.24.
enable_csi_u_key_encoding
18.2.25.
enable_scroll_bar
18.2.26.
enable_tab_bar
18.2.27.
enable_wayland
18.2.28.
exit_behavior
18.2.29.
font
18.2.30.
font_antialias
18.2.31.
font_dirs
18.2.32.
font_hinting
18.2.33.
font_locator
18.2.34.
font_rasterizer
18.2.35.
font_rules
18.2.36.
font_shaper
18.2.37.
font_size
18.2.38.
force_reverse_video_cursor
18.2.39.
foreground_text_hsb
18.2.40.
freetype_interpreter_version
18.2.41.
freetype_load_flags
18.2.42.
freetype_load_target
18.2.43.
freetype_render_target
18.2.44.
front_end
18.2.45.
harfbuzz_features
18.2.46.
hide_tab_bar_if_only_one_tab
18.2.47.
hyperlink_rules
18.2.48.
initial_cols
18.2.49.
initial_rows
18.2.50.
launch_menu
18.2.51.
line_height
18.2.52.
mux_env_remove
18.2.53.
native_macos_fullscreen_mode
18.2.54.
pane_focus_follows_mouse
18.2.55.
prefer_egl
18.2.56.
quick_select_alphabet
18.2.57.
quick_select_patterns
18.2.58.
scroll_to_bottom_on_input
18.2.59.
scrollback_lines
18.2.60.
selection_word_boundary
18.2.61.
set_environment_variables
18.2.62.
show_tab_index_in_tab_bar
18.2.63.
show_update_window
18.2.64.
skip_close_confirmation_for_processes_named
18.2.65.
ssh_backend
18.2.66.
ssh_domains
18.2.67.
status_update_interval
18.2.68.
swallow_mouse_click_on_pane_focus
18.2.69.
swap_backspace_and_delete
18.2.70.
tab_and_split_indices_are_zero_based
18.2.71.
tab_bar_at_bottom
18.2.72.
tab_bar_style
18.2.73.
tab_max_width
18.2.74.
term
18.2.75.
text_blink_rate
18.2.76.
text_blink_rate_rapid
18.2.77.
tls_clients
18.2.78.
tls_servers
18.2.79.
treat_left_ctrlalt_as_altgr
18.2.80.
unicode_version
18.2.81.
unix_domains
18.2.82.
unzoom_on_switch_pane
18.2.83.
use_cap_height_to_scale_fallback_fonts
18.2.84.
use_fancy_tab_bar
18.2.85.
use_ime
18.2.86.
use_resize_increments
18.2.87.
visual_bell
18.2.88.
warn_about_missing_glyphs
18.2.89.
window_background_gradient
18.2.90.
window_close_confirmation
18.2.91.
window_decorations
18.2.92.
window_frame
18.2.93.
window_padding
18.2.94.
wsl_domains
18.2.95.
xim_im_name
18.3.
enum: KeyAssignment
❱
18.3.1.
ActivateCopyMode
18.3.2.
ActivateLastTab
18.3.3.
ActivatePaneByIndex
18.3.4.
ActivatePaneDirection
18.3.5.
ActivateTab
18.3.6.
ActivateTabRelative
18.3.7.
ActivateTabRelativeNoWrap
18.3.8.
AdjustPaneSize
18.3.9.
ClearScrollback
18.3.10.
CloseCurrentPane
18.3.11.
CloseCurrentTab
18.3.12.
CompleteSelection
18.3.13.
CompleteSelectionOrOpenLinkAtMouseCursor
18.3.14.
Copy
18.3.15.
CopyTo
18.3.16.
DecreaseFontSize
18.3.17.
DisableDefaultAssignment
18.3.18.
EmitEvent
18.3.19.
ExtendSelectionToMouseCursor
18.3.20.
Hide
18.3.21.
HideApplication
18.3.22.
IncreaseFontSize
18.3.23.
MoveTab
18.3.24.
MoveTabRelative
18.3.25.
Multiple
18.3.26.
Nop
18.3.27.
OpenLinkAtMouseCursor
18.3.28.
Paste
18.3.29.
PasteFrom
18.3.30.
PastePrimarySelection
18.3.31.
QuickSelect
18.3.32.
QuickSelectArgs
18.3.33.
QuitApplication
18.3.34.
ReloadConfiguration
18.3.35.
ResetFontAndWindowSize
18.3.36.
ResetFontSize
18.3.37.
ScrollByLine
18.3.38.
ScrollByPage
18.3.39.
ScrollToBottom
18.3.40.
ScrollToPrompt
18.3.41.
ScrollToTop
18.3.42.
Search
18.3.43.
SelectTextAtMouseCursor
18.3.44.
SendKey
18.3.45.
SendString
18.3.46.
Show
18.3.47.
ShowDebugOverlay
18.3.48.
ShowLauncher
18.3.49.
ShowLauncherArgs
18.3.50.
ShowTabNavigator
18.3.51.
SpawnCommandInNewTab
18.3.52.
SpawnCommandInNewWindow
18.3.53.
SpawnTab
18.3.54.
SpawnWindow
18.3.55.
SplitHorizontal
18.3.56.
SplitVertical
18.3.57.
StartWindowDrag
18.3.58.
SwitchToWorkspace
18.3.59.
SwitchWorkspaceRelative
18.3.60.
ToggleFullScreen
18.3.61.
TogglePaneZoomState
18.4.
object: PaneInformation
18.5.
object: TabInformation
18.6.
object: SshDomain
18.7.
object: SpawnCommand
18.8.
object: TlsDomainClient
18.9.
object: TlsDomainServer
18.10.
object: Pane
❱
18.10.1.
get_current_working_dir
18.10.2.
get_cursor_position
18.10.3.
get_dimensions
18.10.4.
get_foreground_process_name
18.10.5.
get_lines_as_text
18.10.6.
get_logical_lines_as_text
18.10.7.
get_title
18.10.8.
get_user_vars
18.10.9.
pane_id
18.10.10.
paste
18.11.
object: Window
❱
18.11.1.
active_workspace
18.11.2.
composition_status
18.11.3.
effective_config
18.11.4.
get_appearance
18.11.5.
get_config_overrides
18.11.6.
get_dimensions
18.11.7.
get_selection_text_for_pane
18.11.8.
leader_is_active
18.11.9.
perform_action
18.11.10.
set_config_overrides
18.11.11.
set_right_status
18.11.12.
toast_notification
18.11.13.
window_id
18.12.
object: WslDomain
18.13.
events: Multiplexer
❱
18.13.1.
mux-is-process-stateful
18.14.
events: Window
❱
18.14.1.
bell
18.14.2.
format-tab-title
18.14.3.
format-window-title
18.14.4.
open-uri
18.14.5.
update-right-status
18.14.6.
window-config-reloaded
18.14.7.
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