Skip to content
wakterm
Tags
Initializing search
wakamex/wakterm
wakterm
Download
Configuration
Full Config & Lua Reference
CLI Reference
Reference
Get Help
Change Log
Sponsor
wakterm
wakamex/wakterm
wakterm
wakterm
Features
Scrollback
Quick Select Mode
Copy Mode
Hyperlinks
Shell Integration
iTerm Image Protocol
SSH
Serial Ports & Arduino
Multiplexing
Download
Download
Download
Windows
macOS
Linux
FreeBSD
NetBSD
Build from source
Configuration
Configuration
Configuration
Colors & Appearance
Launching Programs
Fonts
Font Shaping
Keyboard Concepts
Key Binding
Key Tables
Default Key Assignments
Keyboard Encoding
Mouse Binding
Plugins
Color Schemes
Color Schemes
3
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Recipes
Recipes
Use hyperlinks directly in the terminal
Passing Data from a pane to Lua
Workspaces / Sessions
Full Config & Lua Reference
Full Config & Lua Reference
Full Config & Lua Reference
Config Options
Config Options
adjust_window_size_when_changing_font_size
allow_square_glyphs_to_overflow_width
allow_win32_input_mode
alternate_buffer_wheel_scroll_speed
animation_fps
anti_alias_custom_block_glyphs
audible_bell
automatically_reload_config
background
bold_brightens_ansi_colors
bypass_mouse_reporting_modifiers
canonicalize_pasted_newlines
cell_width
cell_widths
char_select_bg_color
char_select_fg_color
char_select_font
char_select_font_size
check_for_updates
clean_exit_codes
color_schemes
colors
command_palette_bg_color
command_palette_fg_color
command_palette_font
command_palette_font_size
command_palette_rows
cursor_blink_ease_in
cursor_blink_ease_out
cursor_blink_rate
cursor_thickness
custom_block_glyphs
daemon_options
debug_key_events
default_cursor_style
default_cwd
default_domain
default_gui_startup_args
default_mux_server_domain
default_prog
default_ssh_auth_sock
default_workspace
detect_password_input
disable_default_mouse_bindings
disable_default_quick_select_patterns
display_pixel_geometry
dpi
enable_csi_u_key_encoding
enable_kitty_keyboard
enable_scroll_bar
enable_tab_bar
enable_wayland
exit_behavior
exit_behavior_messaging
font
font_antialias
font_dirs
font_hinting
font_locator
font_rasterizer
font_rules
font_shaper
font_size
force_reverse_video_cursor
foreground_text_hsb
freetype_interpreter_version
freetype_load_flags
freetype_load_target
freetype_pcf_long_family_names
freetype_render_target
front_end
harfbuzz_features
hide_mouse_cursor_when_typing
hide_tab_bar_if_only_one_tab
hyperlink_rules
ime_preedit_rendering
initial_cols
initial_rows
integrated_title_button_alignment
integrated_title_button_color
integrated_title_button_style
integrated_title_buttons
kde_window_background_blur
key_map_preference
key_tables
launch_menu
launcher_alphabet
line_height
log_unknown_escape_sequences
macos_forward_to_ime_modifier_mask
macos_fullscreen_extend_behind_notch
macos_window_background_blur
max_fps
min_scroll_bar_height
mouse_wheel_scrolls_tabs
mux_enable_ssh_agent
mux_env_remove
native_macos_fullscreen_mode
normalize_output_to_unicode_nfc
notification_handling
pane_focus_follows_mouse
pane_select_font
prefer_egl
prefer_to_spawn_tabs
quick_select_alphabet
quick_select_patterns
quick_select_remove_styling
quit_when_all_windows_are_closed
quote_dropped_files
reverse_video_cursor_min_contrast
scroll_to_bottom_on_input
scrollback_lines
selection_word_boundary
serial_ports
set_environment_variables
show_close_tab_button_in_tabs
show_new_tab_button_in_tab_bar
show_tab_index_in_tab_bar
show_tabs_in_tab_bar
show_update_window
skip_close_confirmation_for_processes_named
ssh_backend
ssh_domains
status_update_interval
strikethrough_position
swallow_mouse_click_on_pane_focus
swallow_mouse_click_on_window_focus
swap_backspace_and_delete
switch_to_last_active_tab_when_closing_tab
tab_and_split_indices_are_zero_based
tab_bar_at_bottom
tab_bar_style
tab_max_width
term
text_blink_ease_in
text_blink_ease_out
text_blink_rapid_ease_in
text_blink_rapid_ease_out
text_blink_rate
text_blink_rate_rapid
text_min_contrast_ratio
tiling_desktop_environments
tls_clients
tls_servers
treat_east_asian_ambiguous_width_as_wide
treat_left_ctrlalt_as_altgr
ui_key_cap_rendering
ulimit_nofile
ulimit_nproc
underline_position
underline_thickness
unicode_version
unix_domains
unzoom_on_switch_pane
use_cap_height_to_scale_fallback_fonts
use_fancy_tab_bar
use_ime
use_resize_increments
visual_bell
warn_about_missing_glyphs
webgpu_force_fallback_adapter
webgpu_power_preference
webgpu_preferred_adapter
win32_acrylic_accent_color
win32_system_backdrop
window_background_gradient
window_close_confirmation
window_content_alignment
window_decorations
window_frame
window_padding
wsl_domains
xim_im_name
module: wakterm
module: wakterm
GLOBAL
action
action_callback
add_to_config_reload_watch_list
background_child_process
battery_info
column_width
config_builder
config_dir
config_file
default_hyperlink_rules
default_ssh_domains
default_wsl_domains
emit
enumerate_ssh_hosts
executable_dir
font
font_with_fallback
format
get_builtin_color_schemes
glob
gradient_colors
has_action
home_dir
hostname
json_encode
json_parse
log_error
log_info
log_warn
nerdfonts
on
open_with
pad_left
pad_right
permute_any_mods
permute_any_or_no_mods
read_dir
reload_configuration
run_child_process
running_under_wsl
shell_join_args
shell_quote_arg
shell_split
sleep_ms
split_by_newlines
strftime
strftime_utc
target_triple
to_string
truncate_left
truncate_right
utf16_to_utf8
version
module: wakterm.color
module: wakterm.color
extract_colors_from_image
from_hsla
get_builtin_schemes
get_default_colors
gradient
load_base16_scheme
load_scheme
load_terminal_sexy_scheme
parse
save_scheme
module: wakterm.gui
module: wakterm.gui
default_key_tables
default_keys
enumerate_gpus
get_appearance
gui_window_for_mux_window
gui_windows
screens
module: wakterm.mux
module: wakterm.mux
all_domains
all_windows
get_active_workspace
get_domain
get_pane
get_tab
get_window
get_workspace_names
rename_workspace
set_active_workspace
set_default_domain
spawn_window
module: wakterm.plugin
module: wakterm.plugin
list
require
update_all
module: wakterm.procinfo
module: wakterm.procinfo
current_working_dir_for_pid
executable_path_for_pid
get_info_for_pid
pid
module: wakterm.serde
module: wakterm.serde
json_decode
json_encode
json_encode_pretty
toml_decode
toml_encode
toml_encode_pretty
yaml_decode
yaml_encode
module: wakterm.time
module: wakterm.time
call_after
now
parse
parse_rfc3339
module: wakterm.url
module: wakterm.url
Url
parse
enum: KeyAssignment
enum: KeyAssignment
ActivateCommandPalette
ActivateCopyMode
ActivateKeyTable
ActivateLastTab
ActivatePaneByIndex
ActivatePaneDirection
ActivateTab
ActivateTabRelative
ActivateTabRelativeNoWrap
ActivateWindow
ActivateWindowRelative
ActivateWindowRelativeNoWrap
AdjustPaneSize
AttachDomain
CharSelect
ClearKeyTableStack
ClearScrollback
ClearSelection
CloseCurrentPane
CloseCurrentTab
CompleteSelection
CompleteSelectionOrOpenLinkAtMouseCursor
Confirmation
Copy
CopyTo
DecreaseFontSize
DetachDomain
DisableDefaultAssignment
EmitEvent
ExtendSelectionToMouseCursor
Hide
HideApplication
IncreaseFontSize
InputSelector
MoveTab
MoveTabRelative
Multiple
Nop
OpenLinkAtMouseCursor
PaneSelect
Paste
PasteFrom
PastePrimarySelection
PopKeyTable
PromptInputLine
QuickSelect
QuickSelectArgs
QuitApplication
ReloadConfiguration
ResetFontAndWindowSize
ResetFontSize
ResetTerminal
RotatePanes
ScrollByCurrentEventWheelDelta
ScrollByLine
ScrollByPage
ScrollToBottom
ScrollToPrompt
ScrollToTop
Search
SelectTextAtMouseCursor
SendKey
SendString
SetPaneZoomState
SetWindowLevel
Show
ShowDebugOverlay
ShowLauncher
ShowLauncherArgs
ShowTabNavigator
SpawnCommandInNewTab
SpawnCommandInNewWindow
SpawnTab
SpawnWindow
SplitHorizontal
SplitPane
SplitVertical
StartWindowDrag
SwitchToWorkspace
SwitchWorkspaceRelative
ToggleAlwaysOnBottom
ToggleAlwaysOnTop
ToggleFullScreen
TogglePaneZoomState
enum: CopyModeAssignment
enum: CopyModeAssignment
AcceptPattern
ClearPattern
ClearSelectionMode
Close
CycleMatchType
EditPattern
MoveBackwardSemanticZone
MoveBackwardSemanticZoneOfType
MoveBackwardWord
MoveDown
MoveForwardSemanticZone
MoveForwardSemanticZoneOfType
MoveForwardWord
MoveForwardWordEnd
MoveLeft
MoveRight
MoveToEndOfLineContent
MoveToScrollbackBottom
MoveToScrollbackTop
MoveToSelectionOtherEnd
MoveToSelectionOtherEndHoriz
MoveToStartOfLine
MoveToStartOfLineContent
MoveToStartOfNextLine
MoveToViewportBottom
MoveToViewportMiddle
MoveToViewportTop
MoveUp
NextMatch
NextMatchPage
PriorMatch
PriorMatchPage
SetSelectionMode
object: Color
object: Color
adjust_hue_fixed
adjust_hue_fixed_ryb
complement
complement_ryb
contrast_ratio
darken
darken_fixed
delta_e
desaturate
desaturate_fixed
hsla
laba
lighten
lighten_fixed
linear_rgba
saturate
saturate_fixed
square
srgb_u8
triad
object: ExecDomain
object: LocalProcessInfo
object: MuxDomain
object: MuxDomain
attach
detach
domain_id
has_any_panes
is_spawnable
label
name
state
object: MuxWindow
object: MuxWindow
active_pane
active_tab
get_title
get_workspace
gui_window
set_title
set_workspace
spawn_tab
tabs
tabs_with_info
window_id
object: MuxTab
object: MuxTab
activate
active_pane
get_pane_direction
get_size
get_title
panes
panes_with_info
rotate_clockwise
rotate_counter_clockwise
set_title
set_zoomed
tab_id
window
object: PaneInformation
object: TabInformation
object: SshDomain
object: SpawnCommand
object: Time
object: Time
format
format_utc
sun_times
object: TlsDomainClient
object: TlsDomainServer
object: Pane
object: Pane
activate
get_current_working_dir
get_cursor_position
get_dimensions
get_domain_name
get_foreground_process_info
get_foreground_process_name
get_lines_as_escapes
get_lines_as_text
get_logical_lines_as_text
get_metadata
get_progress
get_semantic_zone_at
get_semantic_zones
get_text_from_region
get_text_from_semantic_zone
get_title
get_tty_name
get_user_vars
has_unseen_output
inject_output
is_alt_screen_active
move_to_new_tab
move_to_new_window
mux_pane
pane_id
paste
send_paste
send_text
split
tab
window
object: Window
object: Window
active_key_table
active_pane
active_tab
active_workspace
composition_status
copy_to_clipboard
current_event
effective_config
focus
get_appearance
get_config_overrides
get_dimensions
get_selection_escapes_for_pane
get_selection_text_for_pane
is_focused
keyboard_modifiers
leader_is_active
maximize
mux_window
perform_action
restore
set_config_overrides
set_inner_size
set_left_status
set_position
set_right_status
toast_notification
toggle_fullscreen
window_id
object: WslDomain
events: Gui
events: Gui
gui-attached
gui-startup
events: Multiplexer
events: Multiplexer
mux-is-process-stateful
mux-startup
events: Window
events: Window
augment-command-palette
bell
format-tab-title
format-window-title
new-tab-button-click
open-uri
update-right-status
update-status
user-var-changed
window-config-reloaded
window-focus-changed
window-resized
CLI Reference
CLI Reference
CLI Reference
wakterm cli
wakterm cli
activate-pane-direction
activate-pane
activate-tab
adjust-pane-size
get-pane-direction
get-text
kill-pane
list-clients
list
move-pane-to-new-tab
rename-workspace
send-text
set-tab-title
set-window-title
spawn
split-pane
zoom-pane
wakterm connect
wakterm imgcat
wakterm ls-fonts
wakterm record
wakterm replay
wakterm serial
wakterm set-working-directory
wakterm show-keys
wakterm ssh
wakterm start
Reference
Reference
Escape Sequences
What is a Terminal?
Get Help
Get Help
Troubleshooting
F.A.Q.
Getting Help
Contributing
Change Log
Sponsor
Tags
¶
Find documentation grouped by tag:
Back to top