1. root
  2. WezTerm
    1. Features
    2. Scrollback
    3. Quick Select Mode
    4. Copy Mode
    5. Hyperlinks
    6. Shell Integration
    7. iTerm Image Protocol
    8. SSH
    9. Serial Ports & Arduino
    10. Multiplexing
  3. Configuration
    1. Colors & Appearance
    2. Launching Programs
    3. Fonts
    4. Font Shaping
    5. Keyboard Concepts
    6. Key Binding
    7. Key Tables
    8. Default Key Assignments
    9. Keyboard Encoding
    10. Mouse Binding
    11. Color Schemes
      1. 3
      2. a
      3. b
      4. c
      5. d
      6. e
      7. f
      8. g
      9. h
      10. i
      11. j
      12. k
      13. l
      14. m
      15. n
      16. o
      17. p
      18. q
      19. r
      20. s
      21. t
      22. u
      23. v
      24. w
      25. x
      26. y
      27. z
    12. Recipes
      1. Passing Data from a pane to Lua
      2. Workspaces / Sessions
  4. Full Config & Lua Reference
    1. Config Options
      1. adjust_window_size_when_changing_font_size
      2. allow_square_glyphs_to_overflow_width
      3. allow_win32_input_mode
      4. alternate_buffer_wheel_scroll_speed
      5. animation_fps
      6. anti_alias_custom_block_glyphs
      7. audible_bell
      8. automatically_reload_config
      9. background
      10. bold_brightens_ansi_colors
      11. bypass_mouse_reporting_modifiers
      12. canonicalize_pasted_newlines
      13. cell_width
      14. char_select_bg_color
      15. char_select_fg_color
      16. char_select_font_size
      17. check_for_updates
      18. clean_exit_codes
      19. color_schemes
      20. colors
      21. command_palette_bg_color
      22. command_palette_fg_color
      23. command_palette_font_size
      24. command_palette_rows
      25. cursor_blink_ease_in
      26. cursor_blink_ease_out
      27. cursor_blink_rate
      28. cursor_thickness
      29. custom_block_glyphs
      30. daemon_options
      31. debug_key_events
      32. default_cursor_style
      33. default_cwd
      34. default_domain
      35. default_gui_startup_args
      36. default_mux_server_domain
      37. default_prog
      38. default_workspace
      39. detect_password_input
      40. disable_default_mouse_bindings
      41. disable_default_quick_select_patterns
      42. display_pixel_geometry
      43. dpi
      44. enable_csi_u_key_encoding
      45. enable_kitty_keyboard
      46. enable_scroll_bar
      47. enable_tab_bar
      48. enable_wayland
      49. exit_behavior
      50. exit_behavior_messaging
      51. font
      52. font_antialias
      53. font_dirs
      54. font_hinting
      55. font_locator
      56. font_rasterizer
      57. font_rules
      58. font_shaper
      59. font_size
      60. force_reverse_video_cursor
      61. foreground_text_hsb
      62. freetype_interpreter_version
      63. freetype_load_flags
      64. freetype_load_target
      65. freetype_pcf_long_family_names
      66. freetype_render_target
      67. front_end
      68. harfbuzz_features
      69. hide_mouse_cursor_when_typing
      70. hide_tab_bar_if_only_one_tab
      71. hyperlink_rules
      72. ime_preedit_rendering
      73. initial_cols
      74. initial_rows
      75. integrated_title_button_alignment
      76. integrated_title_button_color
      77. integrated_title_button_style
      78. integrated_title_buttons
      79. key_map_preference
      80. key_tables
      81. launch_menu
      82. line_height
      83. log_unknown_escape_sequences
      84. macos_forward_to_ime_modifier_mask
      85. macos_window_background_blur
      86. max_fps
      87. min_scroll_bar_height
      88. mouse_wheel_scrolls_tabs
      89. mux_env_remove
      90. native_macos_fullscreen_mode
      91. normalize_output_to_unicode_nfc
      92. notification_handling
      93. pane_focus_follows_mouse
      94. prefer_egl
      95. prefer_to_spawn_tabs
      96. quick_select_alphabet
      97. quick_select_patterns
      98. quit_when_all_windows_are_closed
      99. quote_dropped_files
      100. scroll_to_bottom_on_input
      101. scrollback_lines
      102. selection_word_boundary
      103. serial_ports
      104. set_environment_variables
      105. show_new_tab_button_in_tab_bar
      106. show_tab_index_in_tab_bar
      107. show_tabs_in_tab_bar
      108. show_update_window
      109. skip_close_confirmation_for_processes_named
      110. ssh_backend
      111. ssh_domains
      112. status_update_interval
      113. strikethrough_position
      114. swallow_mouse_click_on_pane_focus
      115. swallow_mouse_click_on_window_focus
      116. swap_backspace_and_delete
      117. switch_to_last_active_tab_when_closing_tab
      118. tab_and_split_indices_are_zero_based
      119. tab_bar_at_bottom
      120. tab_bar_style
      121. tab_max_width
      122. term
      123. text_blink_ease_in
      124. text_blink_ease_out
      125. text_blink_rapid_ease_in
      126. text_blink_rapid_ease_out
      127. text_blink_rate
      128. text_blink_rate_rapid
      129. tiling_desktop_environments
      130. tls_clients
      131. tls_servers
      132. treat_east_asian_ambiguous_width_as_wide
      133. treat_left_ctrlalt_as_altgr
      134. ulimit_nofile
      135. ulimit_nproc
      136. underline_position
      137. underline_thickness
      138. unicode_version
      139. unix_domains
      140. unzoom_on_switch_pane
      141. use_cap_height_to_scale_fallback_fonts
      142. use_fancy_tab_bar
      143. use_ime
      144. use_resize_increments
      145. visual_bell
      146. warn_about_missing_glyphs
      147. webgpu_force_fallback_adapter
      148. webgpu_power_preference
      149. webgpu_preferred_adapter
      150. win32_acrylic_accent_color
      151. win32_system_backdrop
      152. window_background_gradient
      153. window_close_confirmation
      154. window_decorations
      155. window_frame
      156. window_padding
      157. wsl_domains
      158. xim_im_name
    2. module: wezterm
      1. GLOBAL
      2. action
      3. action_callback
      4. add_to_config_reload_watch_list
      5. background_child_process
      6. battery_info
      7. column_width
      8. config_builder
      9. config_dir
      10. config_file
      11. default_hyperlink_rules
      12. default_ssh_domains
      13. default_wsl_domains
      14. emit
      15. enumerate_ssh_hosts
      16. executable_dir
      17. font
      18. font_with_fallback
      19. format
      20. get_builtin_color_schemes
      21. glob
      22. gradient_colors
      23. has_action
      24. home_dir
      25. hostname
      26. json_encode
      27. json_parse
      28. log_error
      29. log_info
      30. log_warn
      31. nerdfonts
      32. on
      33. open_with
      34. pad_left
      35. pad_right
      36. permute_any_mods
      37. permute_any_or_no_mods
      38. read_dir
      39. reload_configuration
      40. run_child_process
      41. running_under_wsl
      42. shell_join_args
      43. shell_quote_arg
      44. shell_split
      45. sleep_ms
      46. split_by_newlines
      47. strftime
      48. strftime_utc
      49. target_triple
      50. to_string
      51. truncate_left
      52. truncate_right
      53. utf16_to_utf8
      54. version
    3. module: wezterm.color
      1. extract_colors_from_image
      2. from_hsla
      3. get_builtin_schemes
      4. get_default_colors
      5. gradient
      6. load_base16_scheme
      7. load_scheme
      8. load_terminal_sexy_scheme
      9. parse
      10. save_scheme
    4. module: wezterm.gui
      1. default_key_tables
      2. default_keys
      3. enumerate_gpus
      4. get_appearance
      5. gui_window_for_mux_window
      6. gui_windows
      7. screens
    5. module: wezterm.mux
      1. all_domains
      2. all_windows
      3. get_active_workspace
      4. get_domain
      5. get_pane
      6. get_tab
      7. get_window
      8. get_workspace_names
      9. rename_workspace
      10. set_active_workspace
      11. set_default_domain
      12. spawn_window
    6. module: wezterm.procinfo
      1. current_working_dir_for_pid
      2. executable_path_for_pid
      3. get_info_for_pid
      4. pid
    7. module: wezterm.time
      1. call_after
      2. now
      3. parse
      4. parse_rfc3339
    8. module: wezterm.url
      1. Url
      2. parse
    9. enum: KeyAssignment
      1. ActivateCommandPalette
      2. ActivateCopyMode
      3. ActivateKeyTable
      4. ActivateLastTab
      5. ActivatePaneByIndex
      6. ActivatePaneDirection
      7. ActivateTab
      8. ActivateTabRelative
      9. ActivateTabRelativeNoWrap
      10. ActivateWindow
      11. ActivateWindowRelative
      12. ActivateWindowRelativeNoWrap
      13. AdjustPaneSize
      14. AttachDomain
      15. CharSelect
      16. ClearKeyTableStack
      17. ClearScrollback
      18. ClearSelection
      19. CloseCurrentPane
      20. CloseCurrentTab
      21. CompleteSelection
      22. CompleteSelectionOrOpenLinkAtMouseCursor
      23. Copy
      24. CopyTo
      25. DecreaseFontSize
      26. DetachDomain
      27. DisableDefaultAssignment
      28. EmitEvent
      29. ExtendSelectionToMouseCursor
      30. Hide
      31. HideApplication
      32. IncreaseFontSize
      33. InputSelector
      34. MoveTab
      35. MoveTabRelative
      36. Multiple
      37. Nop
      38. OpenLinkAtMouseCursor
      39. PaneSelect
      40. Paste
      41. PasteFrom
      42. PastePrimarySelection
      43. PopKeyTable
      44. PromptInputLine
      45. QuickSelect
      46. QuickSelectArgs
      47. QuitApplication
      48. ReloadConfiguration
      49. ResetFontAndWindowSize
      50. ResetFontSize
      51. ResetTerminal
      52. RotatePanes
      53. ScrollByCurrentEventWheelDelta
      54. ScrollByLine
      55. ScrollByPage
      56. ScrollToBottom
      57. ScrollToPrompt
      58. ScrollToTop
      59. Search
      60. SelectTextAtMouseCursor
      61. SendKey
      62. SendString
      63. SetPaneZoomState
      64. SetWindowLevel
      65. Show
      66. ShowDebugOverlay
      67. ShowLauncher
      68. ShowLauncherArgs
      69. ShowTabNavigator
      70. SpawnCommandInNewTab
      71. SpawnCommandInNewWindow
      72. SpawnTab
      73. SpawnWindow
      74. SplitHorizontal
      75. SplitPane
      76. SplitVertical
      77. StartWindowDrag
      78. SwitchToWorkspace
      79. SwitchWorkspaceRelative
      80. ToggleAlwaysOnBottom
      81. ToggleAlwaysOnTop
      82. ToggleFullScreen
      83. TogglePaneZoomState
    10. enum: CopyModeAssignment
      1. AcceptPattern
      2. ClearPattern
      3. ClearSelectionMode
      4. Close
      5. CycleMatchType
      6. EditPattern
      7. MoveBackwardSemanticZone
      8. MoveBackwardSemanticZoneOfType
      9. MoveBackwardWord
      10. MoveDown
      11. MoveForwardSemanticZone
      12. MoveForwardSemanticZoneOfType
      13. MoveForwardWord
      14. MoveForwardWordEnd
      15. MoveLeft
      16. MoveRight
      17. MoveToEndOfLineContent
      18. MoveToScrollbackBottom
      19. MoveToScrollbackTop
      20. MoveToSelectionOtherEnd
      21. MoveToSelectionOtherEndHoriz
      22. MoveToStartOfLine
      23. MoveToStartOfLineContent
      24. MoveToStartOfNextLine
      25. MoveToViewportBottom
      26. MoveToViewportMiddle
      27. MoveToViewportTop
      28. MoveUp
      29. NextMatch
      30. NextMatchPage
      31. PriorMatch
      32. PriorMatchPage
      33. SetSelectionMode
    11. object: Color
      1. adjust_hue_fixed
      2. adjust_hue_fixed_ryb
      3. complement
      4. complement_ryb
      5. contrast_ratio
      6. darken
      7. darken_fixed
      8. delta_e
      9. desaturate
      10. desaturate_fixed
      11. hsla
      12. laba
      13. lighten
      14. lighten_fixed
      15. linear_rgba
      16. saturate
      17. saturate_fixed
      18. square
      19. srgb_u8
      20. triad
    12. object: ExecDomain
    13. object: LocalProcessInfo
    14. object: MuxDomain
      1. attach
      2. detach
      3. domain_id
      4. has_any_panes
      5. is_spawnable
      6. label
      7. name
      8. state
    15. object: MuxWindow
      1. active_pane
      2. active_tab
      3. get_title
      4. get_workspace
      5. gui_window
      6. set_title
      7. set_workspace
      8. spawn_tab
      9. tabs
      10. tabs_with_info
      11. window_id
    16. object: MuxTab
      1. activate
      2. active_pane
      3. get_pane_direction
      4. get_size
      5. get_title
      6. panes
      7. panes_with_info
      8. rotate_clockwise
      9. rotate_counter_clockwise
      10. set_title
      11. set_zoomed
      12. tab_id
      13. window
    17. object: PaneInformation
    18. object: TabInformation
    19. object: SshDomain
    20. object: SpawnCommand
    21. object: Time
      1. format
      2. format_utc
      3. sun_times
    22. object: TlsDomainClient
    23. object: TlsDomainServer
    24. object: Pane
      1. activate
      2. get_current_working_dir
      3. get_cursor_position
      4. get_dimensions
      5. get_domain_name
      6. get_foreground_process_info
      7. get_foreground_process_name
      8. get_lines_as_escapes
      9. get_lines_as_text
      10. get_logical_lines_as_text
      11. get_metadata
      12. get_semantic_zone_at
      13. get_semantic_zones
      14. get_text_from_region
      15. get_text_from_semantic_zone
      16. get_title
      17. get_tty_name
      18. get_user_vars
      19. has_unseen_output
      20. inject_output
      21. is_alt_screen_active
      22. move_to_new_tab
      23. move_to_new_window
      24. mux_pane
      25. pane_id
      26. paste
      27. send_paste
      28. send_text
      29. split
      30. tab
      31. window
    25. object: Window
      1. active_key_table
      2. active_pane
      3. active_tab
      4. active_workspace
      5. composition_status
      6. copy_to_clipboard
      7. current_event
      8. effective_config
      9. focus
      10. get_appearance
      11. get_config_overrides
      12. get_dimensions
      13. get_selection_escapes_for_pane
      14. get_selection_text_for_pane
      15. is_focused
      16. keyboard_modifiers
      17. leader_is_active
      18. maximize
      19. mux_window
      20. perform_action
      21. restore
      22. set_config_overrides
      23. set_inner_size
      24. set_left_status
      25. set_position
      26. set_right_status
      27. toast_notification
      28. toggle_fullscreen
      29. window_id
    26. object: WslDomain
    27. events: Gui
      1. gui-attached
      2. gui-startup
    28. events: Multiplexer
      1. mux-is-process-stateful
      2. mux-startup
    29. events: Window
      1. augment-command-palette
      2. bell
      3. format-tab-title
      4. format-window-title
      5. new-tab-button-click
      6. open-uri
      7. update-right-status
      8. update-status
      9. user-var-changed
      10. window-config-reloaded
      11. window-focus-changed
      12. window-resized
  5. CLI Reference
    1. wezterm cli
      1. activate-pane-direction
      2. activate-pane
      3. activate-tab
      4. adjust-pane-size
      5. get-pane-direction
      6. get-text
      7. kill-pane
      8. list-clients
      9. list
      10. move-pane-to-new-tab
      11. rename-workspace
      12. send-text
      13. set-tab-title
      14. set-window-title
      15. spawn
      16. split-pane
      17. zoom-pane
    2. wezterm connect
    3. wezterm imgcat
    4. wezterm ls-fonts
    5. wezterm record
    6. wezterm replay
    7. wezterm serial
    8. wezterm set-working-directory
    9. wezterm show-keys
    10. wezterm ssh
    11. wezterm start
    12. Escape Sequences
    13. What is a Terminal?
    14. Troubleshooting
    15. F.A.Q.
    16. Getting Help
    17. Contributing
  6. Change Log
  7. Sponsor