- 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. Full Config & Lua Reference
❱
- 3.1. Config Options
❱
- 3.1.1. adjust_window_size_when_changing_font_size
- 3.1.2. allow_square_glyphs_to_overflow_width
- 3.1.3. allow_win32_input_mode
- 3.1.4. alternate_buffer_wheel_scroll_speed
- 3.1.5. animation_fps
- 3.1.6. anti_alias_custom_block_glyphs
- 3.1.7. audible_bell
- 3.1.8. automatically_reload_config
- 3.1.9. background
- 3.1.10. bold_brightens_ansi_colors
- 3.1.11. bypass_mouse_reporting_modifiers
- 3.1.12. canonicalize_pasted_newlines
- 3.1.13. cell_width
- 3.1.14. char_select_bg_color
- 3.1.15. char_select_fg_color
- 3.1.16. char_select_font_size
- 3.1.17. check_for_updates
- 3.1.18. clean_exit_codes
- 3.1.19. color_schemes
- 3.1.20. colors
- 3.1.21. command_palette_bg_color
- 3.1.22. command_palette_fg_color
- 3.1.23. command_palette_font_size
- 3.1.24. command_palette_rows
- 3.1.25. cursor_blink_ease_in
- 3.1.26. cursor_blink_ease_out
- 3.1.27. cursor_blink_rate
- 3.1.28. cursor_thickness
- 3.1.29. custom_block_glyphs
- 3.1.30. daemon_options
- 3.1.31. debug_key_events
- 3.1.32. default_cursor_style
- 3.1.33. default_cwd
- 3.1.34. default_domain
- 3.1.35. default_gui_startup_args
- 3.1.36. default_mux_server_domain
- 3.1.37. default_prog
- 3.1.38. default_workspace
- 3.1.39. detect_password_input
- 3.1.40. disable_default_mouse_bindings
- 3.1.41. disable_default_quick_select_patterns
- 3.1.42. display_pixel_geometry
- 3.1.43. dpi
- 3.1.44. enable_csi_u_key_encoding
- 3.1.45. enable_kitty_keyboard
- 3.1.46. enable_scroll_bar
- 3.1.47. enable_tab_bar
- 3.1.48. enable_wayland
- 3.1.49. exit_behavior
- 3.1.50. exit_behavior_messaging
- 3.1.51. font
- 3.1.52. font_antialias
- 3.1.53. font_dirs
- 3.1.54. font_hinting
- 3.1.55. font_locator
- 3.1.56. font_rasterizer
- 3.1.57. font_rules
- 3.1.58. font_shaper
- 3.1.59. font_size
- 3.1.60. force_reverse_video_cursor
- 3.1.61. foreground_text_hsb
- 3.1.62. freetype_interpreter_version
- 3.1.63. freetype_load_flags
- 3.1.64. freetype_load_target
- 3.1.65. freetype_pcf_long_family_names
- 3.1.66. freetype_render_target
- 3.1.67. front_end
- 3.1.68. harfbuzz_features
- 3.1.69. hide_mouse_cursor_when_typing
- 3.1.70. hide_tab_bar_if_only_one_tab
- 3.1.71. hyperlink_rules
- 3.1.72. ime_preedit_rendering
- 3.1.73. initial_cols
- 3.1.74. initial_rows
- 3.1.75. integrated_title_button_alignment
- 3.1.76. integrated_title_button_color
- 3.1.77. integrated_title_button_style
- 3.1.78. integrated_title_buttons
- 3.1.79. key_map_preference
- 3.1.80. key_tables
- 3.1.81. launch_menu
- 3.1.82. line_height
- 3.1.83. log_unknown_escape_sequences
- 3.1.84. macos_forward_to_ime_modifier_mask
- 3.1.85. macos_window_background_blur
- 3.1.86. max_fps
- 3.1.87. min_scroll_bar_height
- 3.1.88. mouse_wheel_scrolls_tabs
- 3.1.89. mux_env_remove
- 3.1.90. native_macos_fullscreen_mode
- 3.1.91. normalize_output_to_unicode_nfc
- 3.1.92. notification_handling
- 3.1.93. pane_focus_follows_mouse
- 3.1.94. prefer_egl
- 3.1.95. prefer_to_spawn_tabs
- 3.1.96. quick_select_alphabet
- 3.1.97. quick_select_patterns
- 3.1.98. quit_when_all_windows_are_closed
- 3.1.99. quote_dropped_files
- 3.1.100. scroll_to_bottom_on_input
- 3.1.101. scrollback_lines
- 3.1.102. selection_word_boundary
- 3.1.103. serial_ports
- 3.1.104. set_environment_variables
- 3.1.105. show_new_tab_button_in_tab_bar
- 3.1.106. show_tab_index_in_tab_bar
- 3.1.107. show_tabs_in_tab_bar
- 3.1.108. show_update_window
- 3.1.109. skip_close_confirmation_for_processes_named
- 3.1.110. ssh_backend
- 3.1.111. ssh_domains
- 3.1.112. status_update_interval
- 3.1.113. strikethrough_position
- 3.1.114. swallow_mouse_click_on_pane_focus
- 3.1.115. swallow_mouse_click_on_window_focus
- 3.1.116. swap_backspace_and_delete
- 3.1.117. switch_to_last_active_tab_when_closing_tab
- 3.1.118. tab_and_split_indices_are_zero_based
- 3.1.119. tab_bar_at_bottom
- 3.1.120. tab_bar_style
- 3.1.121. tab_max_width
- 3.1.122. term
- 3.1.123. text_blink_ease_in
- 3.1.124. text_blink_ease_out
- 3.1.125. text_blink_rapid_ease_in
- 3.1.126. text_blink_rapid_ease_out
- 3.1.127. text_blink_rate
- 3.1.128. text_blink_rate_rapid
- 3.1.129. tiling_desktop_environments
- 3.1.130. tls_clients
- 3.1.131. tls_servers
- 3.1.132. treat_east_asian_ambiguous_width_as_wide
- 3.1.133. treat_left_ctrlalt_as_altgr
- 3.1.134. ulimit_nofile
- 3.1.135. ulimit_nproc
- 3.1.136. underline_position
- 3.1.137. underline_thickness
- 3.1.138. unicode_version
- 3.1.139. unix_domains
- 3.1.140. unzoom_on_switch_pane
- 3.1.141. use_cap_height_to_scale_fallback_fonts
- 3.1.142. use_fancy_tab_bar
- 3.1.143. use_ime
- 3.1.144. use_resize_increments
- 3.1.145. visual_bell
- 3.1.146. warn_about_missing_glyphs
- 3.1.147. webgpu_force_fallback_adapter
- 3.1.148. webgpu_power_preference
- 3.1.149. webgpu_preferred_adapter
- 3.1.150. win32_acrylic_accent_color
- 3.1.151. win32_system_backdrop
- 3.1.152. window_background_gradient
- 3.1.153. window_close_confirmation
- 3.1.154. window_decorations
- 3.1.155. window_frame
- 3.1.156. window_padding
- 3.1.157. wsl_domains
- 3.1.158. xim_im_name
- 3.2. module: wezterm
❱
- 3.2.1. GLOBAL
- 3.2.2. action
- 3.2.3. action_callback
- 3.2.4. add_to_config_reload_watch_list
- 3.2.5. background_child_process
- 3.2.6. battery_info
- 3.2.7. column_width
- 3.2.8. config_builder
- 3.2.9. config_dir
- 3.2.10. config_file
- 3.2.11. default_hyperlink_rules
- 3.2.12. default_ssh_domains
- 3.2.13. default_wsl_domains
- 3.2.14. emit
- 3.2.15. enumerate_ssh_hosts
- 3.2.16. executable_dir
- 3.2.17. font
- 3.2.18. font_with_fallback
- 3.2.19. format
- 3.2.20. get_builtin_color_schemes
- 3.2.21. glob
- 3.2.22. gradient_colors
- 3.2.23. has_action
- 3.2.24. home_dir
- 3.2.25. hostname
- 3.2.26. json_encode
- 3.2.27. json_parse
- 3.2.28. log_error
- 3.2.29. log_info
- 3.2.30. log_warn
- 3.2.31. nerdfonts
- 3.2.32. on
- 3.2.33. open_with
- 3.2.34. pad_left
- 3.2.35. pad_right
- 3.2.36. permute_any_mods
- 3.2.37. permute_any_or_no_mods
- 3.2.38. read_dir
- 3.2.39. reload_configuration
- 3.2.40. run_child_process
- 3.2.41. running_under_wsl
- 3.2.42. shell_join_args
- 3.2.43. shell_quote_arg
- 3.2.44. shell_split
- 3.2.45. sleep_ms
- 3.2.46. split_by_newlines
- 3.2.47. strftime
- 3.2.48. strftime_utc
- 3.2.49. target_triple
- 3.2.50. to_string
- 3.2.51. truncate_left
- 3.2.52. truncate_right
- 3.2.53. utf16_to_utf8
- 3.2.54. version
- 3.3. module: wezterm.color
❱
- 3.3.1. extract_colors_from_image
- 3.3.2. from_hsla
- 3.3.3. get_builtin_schemes
- 3.3.4. get_default_colors
- 3.3.5. gradient
- 3.3.6. load_base16_scheme
- 3.3.7. load_scheme
- 3.3.8. load_terminal_sexy_scheme
- 3.3.9. parse
- 3.3.10. save_scheme
- 3.4. module: wezterm.gui
❱
- 3.4.1. default_key_tables
- 3.4.2. default_keys
- 3.4.3. enumerate_gpus
- 3.4.4. get_appearance
- 3.4.5. gui_window_for_mux_window
- 3.4.6. gui_windows
- 3.4.7. screens
- 3.5. module: wezterm.mux
❱
- 3.5.1. all_domains
- 3.5.2. all_windows
- 3.5.3. get_active_workspace
- 3.5.4. get_domain
- 3.5.5. get_pane
- 3.5.6. get_tab
- 3.5.7. get_window
- 3.5.8. get_workspace_names
- 3.5.9. rename_workspace
- 3.5.10. set_active_workspace
- 3.5.11. set_default_domain
- 3.5.12. spawn_window
- 3.6. module: wezterm.procinfo
❱
- 3.6.1. current_working_dir_for_pid
- 3.6.2. executable_path_for_pid
- 3.6.3. get_info_for_pid
- 3.6.4. pid
- 3.7. module: wezterm.time
❱
- 3.7.1. call_after
- 3.7.2. now
- 3.7.3. parse
- 3.7.4. parse_rfc3339
- 3.8. module: wezterm.url
❱
- 3.8.1. Url
- 3.8.2. parse
- 3.9. enum: KeyAssignment
❱
- 3.9.1. ActivateCommandPalette
- 3.9.2. ActivateCopyMode
- 3.9.3. ActivateKeyTable
- 3.9.4. ActivateLastTab
- 3.9.5. ActivatePaneByIndex
- 3.9.6. ActivatePaneDirection
- 3.9.7. ActivateTab
- 3.9.8. ActivateTabRelative
- 3.9.9. ActivateTabRelativeNoWrap
- 3.9.10. ActivateWindow
- 3.9.11. ActivateWindowRelative
- 3.9.12. ActivateWindowRelativeNoWrap
- 3.9.13. AdjustPaneSize
- 3.9.14. AttachDomain
- 3.9.15. CharSelect
- 3.9.16. ClearKeyTableStack
- 3.9.17. ClearScrollback
- 3.9.18. ClearSelection
- 3.9.19. CloseCurrentPane
- 3.9.20. CloseCurrentTab
- 3.9.21. CompleteSelection
- 3.9.22. CompleteSelectionOrOpenLinkAtMouseCursor
- 3.9.23. Copy
- 3.9.24. CopyTo
- 3.9.25. DecreaseFontSize
- 3.9.26. DetachDomain
- 3.9.27. DisableDefaultAssignment
- 3.9.28. EmitEvent
- 3.9.29. ExtendSelectionToMouseCursor
- 3.9.30. Hide
- 3.9.31. HideApplication
- 3.9.32. IncreaseFontSize
- 3.9.33. InputSelector
- 3.9.34. MoveTab
- 3.9.35. MoveTabRelative
- 3.9.36. Multiple
- 3.9.37. Nop
- 3.9.38. OpenLinkAtMouseCursor
- 3.9.39. PaneSelect
- 3.9.40. Paste
- 3.9.41. PasteFrom
- 3.9.42. PastePrimarySelection
- 3.9.43. PopKeyTable
- 3.9.44. PromptInputLine
- 3.9.45. QuickSelect
- 3.9.46. QuickSelectArgs
- 3.9.47. QuitApplication
- 3.9.48. ReloadConfiguration
- 3.9.49. ResetFontAndWindowSize
- 3.9.50. ResetFontSize
- 3.9.51. ResetTerminal
- 3.9.52. RotatePanes
- 3.9.53. ScrollByCurrentEventWheelDelta
- 3.9.54. ScrollByLine
- 3.9.55. ScrollByPage
- 3.9.56. ScrollToBottom
- 3.9.57. ScrollToPrompt
- 3.9.58. ScrollToTop
- 3.9.59. Search
- 3.9.60. SelectTextAtMouseCursor
- 3.9.61. SendKey
- 3.9.62. SendString
- 3.9.63. SetPaneZoomState
- 3.9.64. SetWindowLevel
- 3.9.65. Show
- 3.9.66. ShowDebugOverlay
- 3.9.67. ShowLauncher
- 3.9.68. ShowLauncherArgs
- 3.9.69. ShowTabNavigator
- 3.9.70. SpawnCommandInNewTab
- 3.9.71. SpawnCommandInNewWindow
- 3.9.72. SpawnTab
- 3.9.73. SpawnWindow
- 3.9.74. SplitHorizontal
- 3.9.75. SplitPane
- 3.9.76. SplitVertical
- 3.9.77. StartWindowDrag
- 3.9.78. SwitchToWorkspace
- 3.9.79. SwitchWorkspaceRelative
- 3.9.80. ToggleAlwaysOnBottom
- 3.9.81. ToggleAlwaysOnTop
- 3.9.82. ToggleFullScreen
- 3.9.83. TogglePaneZoomState
- 3.10. enum: CopyModeAssignment
❱
- 3.10.1. AcceptPattern
- 3.10.2. ClearPattern
- 3.10.3. ClearSelectionMode
- 3.10.4. Close
- 3.10.5. CycleMatchType
- 3.10.6. EditPattern
- 3.10.7. MoveBackwardSemanticZone
- 3.10.8. MoveBackwardSemanticZoneOfType
- 3.10.9. MoveBackwardWord
- 3.10.10. MoveDown
- 3.10.11. MoveForwardSemanticZone
- 3.10.12. MoveForwardSemanticZoneOfType
- 3.10.13. MoveForwardWord
- 3.10.14. MoveForwardWordEnd
- 3.10.15. MoveLeft
- 3.10.16. MoveRight
- 3.10.17. MoveToEndOfLineContent
- 3.10.18. MoveToScrollbackBottom
- 3.10.19. MoveToScrollbackTop
- 3.10.20. MoveToSelectionOtherEnd
- 3.10.21. MoveToSelectionOtherEndHoriz
- 3.10.22. MoveToStartOfLine
- 3.10.23. MoveToStartOfLineContent
- 3.10.24. MoveToStartOfNextLine
- 3.10.25. MoveToViewportBottom
- 3.10.26. MoveToViewportMiddle
- 3.10.27. MoveToViewportTop
- 3.10.28. MoveUp
- 3.10.29. NextMatch
- 3.10.30. NextMatchPage
- 3.10.31. PriorMatch
- 3.10.32. PriorMatchPage
- 3.10.33. SetSelectionMode
- 3.11. object: Color
❱
- 3.11.1. adjust_hue_fixed
- 3.11.2. adjust_hue_fixed_ryb
- 3.11.3. complement
- 3.11.4. complement_ryb
- 3.11.5. contrast_ratio
- 3.11.6. darken
- 3.11.7. darken_fixed
- 3.11.8. delta_e
- 3.11.9. desaturate
- 3.11.10. desaturate_fixed
- 3.11.11. hsla
- 3.11.12. laba
- 3.11.13. lighten
- 3.11.14. lighten_fixed
- 3.11.15. linear_rgba
- 3.11.16. saturate
- 3.11.17. saturate_fixed
- 3.11.18. square
- 3.11.19. srgb_u8
- 3.11.20. triad
- 3.12. object: ExecDomain
- 3.13. object: LocalProcessInfo
- 3.14. object: MuxDomain
❱
- 3.14.1. attach
- 3.14.2. detach
- 3.14.3. domain_id
- 3.14.4. has_any_panes
- 3.14.5. is_spawnable
- 3.14.6. label
- 3.14.7. name
- 3.14.8. state
- 3.15. object: MuxWindow
❱
- 3.15.1. active_pane
- 3.15.2. active_tab
- 3.15.3. get_title
- 3.15.4. get_workspace
- 3.15.5. gui_window
- 3.15.6. set_title
- 3.15.7. set_workspace
- 3.15.8. spawn_tab
- 3.15.9. tabs
- 3.15.10. tabs_with_info
- 3.15.11. window_id
- 3.16. object: MuxTab
❱
- 3.16.1. activate
- 3.16.2. active_pane
- 3.16.3. get_pane_direction
- 3.16.4. get_size
- 3.16.5. get_title
- 3.16.6. panes
- 3.16.7. panes_with_info
- 3.16.8. rotate_clockwise
- 3.16.9. rotate_counter_clockwise
- 3.16.10. set_title
- 3.16.11. set_zoomed
- 3.16.12. tab_id
- 3.16.13. window
- 3.17. object: PaneInformation
- 3.18. object: TabInformation
- 3.19. object: SshDomain
- 3.20. object: SpawnCommand
- 3.21. object: Time
❱
- 3.21.1. format
- 3.21.2. format_utc
- 3.21.3. sun_times
- 3.22. object: TlsDomainClient
- 3.23. object: TlsDomainServer
- 3.24. object: Pane
❱
- 3.24.1. activate
- 3.24.2. get_current_working_dir
- 3.24.3. get_cursor_position
- 3.24.4. get_dimensions
- 3.24.5. get_domain_name
- 3.24.6. get_foreground_process_info
- 3.24.7. get_foreground_process_name
- 3.24.8. get_lines_as_escapes
- 3.24.9. get_lines_as_text
- 3.24.10. get_logical_lines_as_text
- 3.24.11. get_metadata
- 3.24.12. get_semantic_zone_at
- 3.24.13. get_semantic_zones
- 3.24.14. get_text_from_region
- 3.24.15. get_text_from_semantic_zone
- 3.24.16. get_title
- 3.24.17. get_tty_name
- 3.24.18. get_user_vars
- 3.24.19. has_unseen_output
- 3.24.20. inject_output
- 3.24.21. is_alt_screen_active
- 3.24.22. move_to_new_tab
- 3.24.23. move_to_new_window
- 3.24.24. mux_pane
- 3.24.25. pane_id
- 3.24.26. paste
- 3.24.27. send_paste
- 3.24.28. send_text
- 3.24.29. split
- 3.24.30. tab
- 3.24.31. window
- 3.25. object: Window
❱
- 3.25.1. active_key_table
- 3.25.2. active_pane
- 3.25.3. active_tab
- 3.25.4. active_workspace
- 3.25.5. composition_status
- 3.25.6. copy_to_clipboard
- 3.25.7. current_event
- 3.25.8. effective_config
- 3.25.9. focus
- 3.25.10. get_appearance
- 3.25.11. get_config_overrides
- 3.25.12. get_dimensions
- 3.25.13. get_selection_escapes_for_pane
- 3.25.14. get_selection_text_for_pane
- 3.25.15. is_focused
- 3.25.16. keyboard_modifiers
- 3.25.17. leader_is_active
- 3.25.18. maximize
- 3.25.19. mux_window
- 3.25.20. perform_action
- 3.25.21. restore
- 3.25.22. set_config_overrides
- 3.25.23. set_inner_size
- 3.25.24. set_left_status
- 3.25.25. set_position
- 3.25.26. set_right_status
- 3.25.27. toast_notification
- 3.25.28. toggle_fullscreen
- 3.25.29. window_id
- 3.26. object: WslDomain
- 3.27. events: Gui
❱
- 3.27.1. gui-attached
- 3.27.2. gui-startup
- 3.28. events: Multiplexer
❱
- 3.28.1. mux-is-process-stateful
- 3.28.2. mux-startup
- 3.29. events: Window
❱
- 3.29.1. augment-command-palette
- 3.29.2. bell
- 3.29.3. format-tab-title
- 3.29.4. format-window-title
- 3.29.5. new-tab-button-click
- 3.29.6. open-uri
- 3.29.7. update-right-status
- 3.29.8. update-status
- 3.29.9. user-var-changed
- 3.29.10. window-config-reloaded
- 3.29.11. window-focus-changed
- 3.29.12. 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. adjust-pane-size
- 4.1.5. get-pane-direction
- 4.1.6. get-text
- 4.1.7. kill-pane
- 4.1.8. list-clients
- 4.1.9. list
- 4.1.10. move-pane-to-new-tab
- 4.1.11. rename-workspace
- 4.1.12. send-text
- 4.1.13. set-tab-title
- 4.1.14. set-window-title
- 4.1.15. spawn
- 4.1.16. split-pane
- 4.1.17. zoom-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