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.
Troubleshooting
6.
Recipes
❱
6.1.
Passing Data from a pane to Lua
6.2.
Workspaces / Sessions
7.
Scrollback
8.
Quick Select Mode
9.
Copy Mode
10.
Hyperlinks
11.
Shell Integration
12.
iTerm Image Protocol
13.
SSH
14.
Serial Ports & Arduino
15.
Multiplexing
16.
Escape Sequences
17.
F.A.Q.
18.
Getting Help
19.
Contributing
20.
What is a Terminal?
21.
CLI Reference
❱
21.1.
cli
❱
21.1.1.
activate-pane-direction
21.1.2.
list-clients
21.1.3.
list
21.1.4.
move-pane-to-new-tab
21.1.5.
send-text
21.1.6.
spawn
21.1.7.
split-pane
21.2.
show-keys
22.
Lua Reference
❱
22.1.
module: wezterm
❱
22.1.1.
GLOBAL
22.1.2.
action
22.1.3.
action_callback
22.1.4.
add_to_config_reload_watch_list
22.1.5.
background_child_process
22.1.6.
battery_info
22.1.7.
column_width
22.1.8.
config_builder
22.1.9.
config_dir
22.1.10.
config_file
22.1.11.
default_wsl_domains
22.1.12.
emit
22.1.13.
enumerate_ssh_hosts
22.1.14.
executable_dir
22.1.15.
font
22.1.16.
font_with_fallback
22.1.17.
format
22.1.18.
get_builtin_color_schemes
22.1.19.
glob
22.1.20.
gradient_colors
22.1.21.
home_dir
22.1.22.
hostname
22.1.23.
json_encode
22.1.24.
json_parse
22.1.25.
log_error
22.1.26.
log_info
22.1.27.
log_warn
22.1.28.
nerdfonts
22.1.29.
on
22.1.30.
open_with
22.1.31.
pad_left
22.1.32.
pad_right
22.1.33.
permute_any_mods
22.1.34.
permute_any_or_no_mods
22.1.35.
read_dir
22.1.36.
reload_configuration
22.1.37.
run_child_process
22.1.38.
running_under_wsl
22.1.39.
shell_join_args
22.1.40.
shell_quote_arg
22.1.41.
shell_split
22.1.42.
sleep_ms
22.1.43.
split_by_newlines
22.1.44.
strftime
22.1.45.
strftime_utc
22.1.46.
target_triple
22.1.47.
truncate_left
22.1.48.
truncate_right
22.1.49.
utf16_to_utf8
22.1.50.
version
22.2.
module: wezterm.color
❱
22.2.1.
extract_colors_from_image
22.2.2.
from_hsla
22.2.3.
get_builtin_schemes
22.2.4.
get_default_colors
22.2.5.
gradient
22.2.6.
load_base16_scheme
22.2.7.
load_scheme
22.2.8.
load_terminal_sexy_scheme
22.2.9.
parse
22.2.10.
save_scheme
22.3.
module: wezterm.gui
❱
22.3.1.
default_key_tables
22.3.2.
default_keys
22.3.3.
get_appearance
22.3.4.
gui_window_for_mux_window
22.3.5.
gui_windows
22.3.6.
screens
22.4.
module: wezterm.mux
❱
22.4.1.
all_domains
22.4.2.
all_windows
22.4.3.
get_active_workspace
22.4.4.
get_domain
22.4.5.
get_pane
22.4.6.
get_tab
22.4.7.
get_window
22.4.8.
get_workspace_names
22.4.9.
set_active_workspace
22.4.10.
set_default_domain
22.4.11.
spawn_window
22.5.
module: wezterm.procinfo
❱
22.5.1.
current_working_dir_for_pid
22.5.2.
executable_path_for_pid
22.5.3.
get_info_for_pid
22.5.4.
pid
22.6.
module: wezterm.time
❱
22.6.1.
call_after
22.6.2.
now
22.6.3.
parse
22.6.4.
parse_rfc3339
22.7.
struct: Config
❱
22.7.1.
adjust_window_size_when_changing_font_size
22.7.2.
allow_square_glyphs_to_overflow_width
22.7.3.
allow_win32_input_mode
22.7.4.
alternate_buffer_wheel_scroll_speed
22.7.5.
animation_fps
22.7.6.
audible_bell
22.7.7.
automatically_reload_config
22.7.8.
background
22.7.9.
bold_brightens_ansi_colors
22.7.10.
bypass_mouse_reporting_modifiers
22.7.11.
canonicalize_pasted_newlines
22.7.12.
cell_width
22.7.13.
check_for_updates
22.7.14.
clean_exit_codes
22.7.15.
color_schemes
22.7.16.
colors
22.7.17.
cursor_blink_ease_in
22.7.18.
cursor_blink_ease_out
22.7.19.
cursor_blink_rate
22.7.20.
cursor_thickness
22.7.21.
custom_block_glyphs
22.7.22.
daemon_options
22.7.23.
debug_key_events
22.7.24.
default_cursor_style
22.7.25.
default_cwd
22.7.26.
default_domain
22.7.27.
default_gui_startup_args
22.7.28.
default_prog
22.7.29.
default_workspace
22.7.30.
detect_password_input
22.7.31.
disable_default_mouse_bindings
22.7.32.
disable_default_quick_select_patterns
22.7.33.
dpi
22.7.34.
enable_csi_u_key_encoding
22.7.35.
enable_kitty_keyboard
22.7.36.
enable_scroll_bar
22.7.37.
enable_tab_bar
22.7.38.
enable_wayland
22.7.39.
exit_behavior
22.7.40.
font
22.7.41.
font_antialias
22.7.42.
font_dirs
22.7.43.
font_hinting
22.7.44.
font_locator
22.7.45.
font_rasterizer
22.7.46.
font_rules
22.7.47.
font_shaper
22.7.48.
font_size
22.7.49.
force_reverse_video_cursor
22.7.50.
foreground_text_hsb
22.7.51.
freetype_interpreter_version
22.7.52.
freetype_load_flags
22.7.53.
freetype_load_target
22.7.54.
freetype_pcf_long_family_names
22.7.55.
freetype_render_target
22.7.56.
front_end
22.7.57.
harfbuzz_features
22.7.58.
hide_mouse_cursor_when_typing
22.7.59.
hide_tab_bar_if_only_one_tab
22.7.60.
hyperlink_rules
22.7.61.
ime_preedit_rendering
22.7.62.
initial_cols
22.7.63.
initial_rows
22.7.64.
key_map_preference
22.7.65.
key_tables
22.7.66.
launch_menu
22.7.67.
line_height
22.7.68.
max_fps
22.7.69.
min_scroll_bar_height
22.7.70.
mux_env_remove
22.7.71.
native_macos_fullscreen_mode
22.7.72.
normalize_output_to_unicode_nfc
22.7.73.
pane_focus_follows_mouse
22.7.74.
prefer_egl
22.7.75.
quick_select_alphabet
22.7.76.
quick_select_patterns
22.7.77.
quote_dropped_files
22.7.78.
scroll_to_bottom_on_input
22.7.79.
scrollback_lines
22.7.80.
selection_word_boundary
22.7.81.
set_environment_variables
22.7.82.
show_new_tab_button_in_tab_bar
22.7.83.
show_tab_index_in_tab_bar
22.7.84.
show_tabs_in_tab_bar
22.7.85.
show_update_window
22.7.86.
skip_close_confirmation_for_processes_named
22.7.87.
ssh_backend
22.7.88.
ssh_domains
22.7.89.
status_update_interval
22.7.90.
strikethrough_position
22.7.91.
swallow_mouse_click_on_pane_focus
22.7.92.
swallow_mouse_click_on_window_focus
22.7.93.
swap_backspace_and_delete
22.7.94.
switch_to_last_active_tab_when_closing_tab
22.7.95.
tab_and_split_indices_are_zero_based
22.7.96.
tab_bar_at_bottom
22.7.97.
tab_bar_style
22.7.98.
tab_max_width
22.7.99.
term
22.7.100.
text_blink_ease_in
22.7.101.
text_blink_ease_out
22.7.102.
text_blink_rapid_ease_in
22.7.103.
text_blink_rapid_ease_out
22.7.104.
text_blink_rate
22.7.105.
text_blink_rate_rapid
22.7.106.
tls_clients
22.7.107.
tls_servers
22.7.108.
treat_east_asian_ambiguous_width_as_wide
22.7.109.
treat_left_ctrlalt_as_altgr
22.7.110.
underline_position
22.7.111.
underline_thickness
22.7.112.
unicode_version
22.7.113.
unix_domains
22.7.114.
unzoom_on_switch_pane
22.7.115.
use_cap_height_to_scale_fallback_fonts
22.7.116.
use_fancy_tab_bar
22.7.117.
use_ime
22.7.118.
use_resize_increments
22.7.119.
visual_bell
22.7.120.
warn_about_missing_glyphs
22.7.121.
window_background_gradient
22.7.122.
window_close_confirmation
22.7.123.
window_decorations
22.7.124.
window_frame
22.7.125.
window_padding
22.7.126.
wsl_domains
22.7.127.
xim_im_name
22.8.
enum: KeyAssignment
❱
22.8.1.
ActivateCopyMode
22.8.2.
ActivateKeyTable
22.8.3.
ActivateLastTab
22.8.4.
ActivatePaneByIndex
22.8.5.
ActivatePaneDirection
22.8.6.
ActivateTab
22.8.7.
ActivateTabRelative
22.8.8.
ActivateTabRelativeNoWrap
22.8.9.
ActivateWindow
22.8.10.
ActivateWindowRelative
22.8.11.
ActivateWindowRelativeNoWrap
22.8.12.
AdjustPaneSize
22.8.13.
AttachDomain
22.8.14.
CharSelect
22.8.15.
ClearKeyTableStack
22.8.16.
ClearScrollback
22.8.17.
ClearSelection
22.8.18.
CloseCurrentPane
22.8.19.
CloseCurrentTab
22.8.20.
CompleteSelection
22.8.21.
CompleteSelectionOrOpenLinkAtMouseCursor
22.8.22.
Copy
22.8.23.
CopyTo
22.8.24.
DecreaseFontSize
22.8.25.
DetachDomain
22.8.26.
DisableDefaultAssignment
22.8.27.
EmitEvent
22.8.28.
ExtendSelectionToMouseCursor
22.8.29.
Hide
22.8.30.
HideApplication
22.8.31.
IncreaseFontSize
22.8.32.
MoveTab
22.8.33.
MoveTabRelative
22.8.34.
Multiple
22.8.35.
Nop
22.8.36.
OpenLinkAtMouseCursor
22.8.37.
PaneSelect
22.8.38.
Paste
22.8.39.
PasteFrom
22.8.40.
PastePrimarySelection
22.8.41.
PopKeyTable
22.8.42.
QuickSelect
22.8.43.
QuickSelectArgs
22.8.44.
QuitApplication
22.8.45.
ReloadConfiguration
22.8.46.
ResetFontAndWindowSize
22.8.47.
ResetFontSize
22.8.48.
ResetTerminal
22.8.49.
RotatePanes
22.8.50.
ScrollByCurrentEventWheelDelta
22.8.51.
ScrollByLine
22.8.52.
ScrollByPage
22.8.53.
ScrollToBottom
22.8.54.
ScrollToPrompt
22.8.55.
ScrollToTop
22.8.56.
Search
22.8.57.
SelectTextAtMouseCursor
22.8.58.
SendKey
22.8.59.
SendString
22.8.60.
SetPaneZoomState
22.8.61.
Show
22.8.62.
ShowDebugOverlay
22.8.63.
ShowLauncher
22.8.64.
ShowLauncherArgs
22.8.65.
ShowTabNavigator
22.8.66.
SpawnCommandInNewTab
22.8.67.
SpawnCommandInNewWindow
22.8.68.
SpawnTab
22.8.69.
SpawnWindow
22.8.70.
SplitHorizontal
22.8.71.
SplitPane
22.8.72.
SplitVertical
22.8.73.
StartWindowDrag
22.8.74.
SwitchToWorkspace
22.8.75.
SwitchWorkspaceRelative
22.8.76.
ToggleFullScreen
22.8.77.
TogglePaneZoomState
22.9.
enum: CopyModeAssignment
❱
22.9.1.
AcceptPattern
22.9.2.
ClearPattern
22.9.3.
ClearSelectionMode
22.9.4.
Close
22.9.5.
CycleMatchType
22.9.6.
EditPattern
22.9.7.
MoveBackwardSemanticZone
22.9.8.
MoveBackwardSemanticZoneOfType
22.9.9.
MoveBackwardWord
22.9.10.
MoveDown
22.9.11.
MoveForwardSemanticZone
22.9.12.
MoveForwardSemanticZoneOfType
22.9.13.
MoveForwardWord
22.9.14.
MoveForwardWordEnd
22.9.15.
MoveLeft
22.9.16.
MoveRight
22.9.17.
MoveToEndOfLineContent
22.9.18.
MoveToScrollbackBottom
22.9.19.
MoveToScrollbackTop
22.9.20.
MoveToSelectionOtherEnd
22.9.21.
MoveToSelectionOtherEndHoriz
22.9.22.
MoveToStartOfLine
22.9.23.
MoveToStartOfLineContent
22.9.24.
MoveToStartOfNextLine
22.9.25.
MoveToViewportBottom
22.9.26.
MoveToViewportMiddle
22.9.27.
MoveToViewportTop
22.9.28.
MoveUp
22.9.29.
NextMatch
22.9.30.
NextMatchPage
22.9.31.
PriorMatch
22.9.32.
PriorMatchPage
22.9.33.
SetSelectionMode
22.10.
object: Color
❱
22.10.1.
adjust_hue_fixed
22.10.2.
adjust_hue_fixed_ryb
22.10.3.
complement
22.10.4.
complement_ryb
22.10.5.
contrast_ratio
22.10.6.
darken
22.10.7.
darken_fixed
22.10.8.
delta_e
22.10.9.
desaturate
22.10.10.
desaturate_fixed
22.10.11.
hsla
22.10.12.
laba
22.10.13.
lighten
22.10.14.
lighten_fixed
22.10.15.
linear_rgba
22.10.16.
saturate
22.10.17.
saturate_fixed
22.10.18.
square
22.10.19.
srgb_u8
22.10.20.
triad
22.11.
object: ExecDomain
22.12.
object: LocalProcessInfo
22.13.
object: MuxDomain
❱
22.13.1.
attach
22.13.2.
detach
22.13.3.
domain_id
22.13.4.
has_any_panes
22.13.5.
is_spawnable
22.13.6.
label
22.13.7.
name
22.13.8.
state
22.14.
object: MuxWindow
❱
22.14.1.
get_title
22.14.2.
get_workspace
22.14.3.
gui_window
22.14.4.
set_title
22.14.5.
set_workspace
22.14.6.
spawn_tab
22.14.7.
tabs
22.14.8.
tabs_with_info
22.14.9.
window_id
22.15.
object: MuxTab
❱
22.15.1.
get_size
22.15.2.
get_title
22.15.3.
panes
22.15.4.
panes_with_info
22.15.5.
rotate_clockwise
22.15.6.
rotate_counter_clockwise
22.15.7.
set_title
22.15.8.
set_zoomed
22.15.9.
tab_id
22.15.10.
window
22.16.
object: PaneInformation
22.17.
object: TabInformation
22.18.
object: SshDomain
22.19.
object: SpawnCommand
22.20.
object: Time
❱
22.20.1.
format
22.20.2.
format_utc
22.20.3.
sun_times
22.21.
object: TlsDomainClient
22.22.
object: TlsDomainServer
22.23.
object: Pane
❱
22.23.1.
get_current_working_dir
22.23.2.
get_cursor_position
22.23.3.
get_dimensions
22.23.4.
get_domain_name
22.23.5.
get_foreground_process_info
22.23.6.
get_foreground_process_name
22.23.7.
get_lines_as_text
22.23.8.
get_logical_lines_as_text
22.23.9.
get_metadata
22.23.10.
get_semantic_zone_at
22.23.11.
get_semantic_zones
22.23.12.
get_text_from_region
22.23.13.
get_text_from_semantic_zone
22.23.14.
get_title
22.23.15.
get_user_vars
22.23.16.
has_unseen_output
22.23.17.
inject_output
22.23.18.
is_alt_screen_active
22.23.19.
mux_pane
22.23.20.
pane_id
22.23.21.
paste
22.23.22.
send_paste
22.23.23.
send_text
22.23.24.
split
22.23.25.
tab
22.23.26.
window
22.24.
object: Window
❱
22.24.1.
active_key_table
22.24.2.
active_workspace
22.24.3.
composition_status
22.24.4.
copy_to_clipboard
22.24.5.
current_event
22.24.6.
effective_config
22.24.7.
focus
22.24.8.
get_appearance
22.24.9.
get_config_overrides
22.24.10.
get_dimensions
22.24.11.
get_selection_escapes_for_pane
22.24.12.
get_selection_text_for_pane
22.24.13.
is_focused
22.24.14.
leader_is_active
22.24.15.
maximize
22.24.16.
mux_window
22.24.17.
perform_action
22.24.18.
restore
22.24.19.
set_config_overrides
22.24.20.
set_inner_size
22.24.21.
set_left_status
22.24.22.
set_position
22.24.23.
set_right_status
22.24.24.
toast_notification
22.24.25.
toggle_fullscreen
22.24.26.
window_id
22.25.
object: WslDomain
22.26.
events: Gui
❱
22.26.1.
gui-attached
22.26.2.
gui-startup
22.27.
events: Multiplexer
❱
22.27.1.
mux-is-process-stateful
22.27.2.
mux-startup
22.28.
events: Window
❱
22.28.1.
bell
22.28.2.
format-tab-title
22.28.3.
format-window-title
22.28.4.
open-uri
22.28.5.
update-right-status
22.28.6.
update-status
22.28.7.
user-var-changed
22.28.8.
window-config-reloaded
22.28.9.
window-focus-changed
22.28.10.
window-resized
Light
Rust
Coal
Navy
Ayu
Wez's Terminal Emulator
pane:send_text(text)
Since: 20220624-141144-bd1b7c5d
Sends text to the pane as-is.