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

Wez's Terminal Emulator

CopyModeAssignment enumeration

Represents a pre-defined function that can be applied to control CopyMode and Search Mode.

Available Key Assignments

  • 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