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. r
      19. 4.11.19. s
      20. 4.11.20. t
      21. 4.11.21. u
      22. 4.11.22. v
      23. 4.11.23. w
      24. 4.11.24. z
  6. 5. Scrollback
  7. 6. Quick Select Mode
  8. 7. Copy Mode
  9. 8. Hyperlinks
  10. 9. Shell Integration
  11. 10. iTerm Image Protocol
  12. 11. SSH
  13. 12. Serial Ports & Arduino
  14. 13. Multiplexing
  15. 14. Escape Sequences
  16. 15. F.A.Q.
  17. 16. Getting Help
  18. 17. Contributing
  19. 18. CLI Reference
    ❱
    1. 18.1. cli
      ❱
      1. 18.1.1. list-clients
      2. 18.1.2. list
      3. 18.1.3. move-pane-to-new-tab
      4. 18.1.4. send-text
      5. 18.1.5. spawn
      6. 18.1.6. split-pane
    2. 18.2. show-keys
  20. 19. Lua Reference
    ❱
    1. 19.1. module: wezterm
      ❱
      1. 19.1.1. GLOBAL
      2. 19.1.2. action
      3. 19.1.3. action_callback
      4. 19.1.4. add_to_config_reload_watch_list
      5. 19.1.5. background_child_process
      6. 19.1.6. battery_info
      7. 19.1.7. column_width
      8. 19.1.8. config_dir
      9. 19.1.9. config_file
      10. 19.1.10. default_wsl_domains
      11. 19.1.11. emit
      12. 19.1.12. enumerate_ssh_hosts
      13. 19.1.13. executable_dir
      14. 19.1.14. font
      15. 19.1.15. font_with_fallback
      16. 19.1.16. format
      17. 19.1.17. get_builtin_color_schemes
      18. 19.1.18. glob
      19. 19.1.19. gradient_colors
      20. 19.1.20. home_dir
      21. 19.1.21. hostname
      22. 19.1.22. log_error
      23. 19.1.23. log_info
      24. 19.1.24. log_warn
      25. 19.1.25. nerdfonts
      26. 19.1.26. on
      27. 19.1.27. open_with
      28. 19.1.28. pad_left
      29. 19.1.29. pad_right
      30. 19.1.30. permute_any_mods
      31. 19.1.31. permute_any_or_no_mods
      32. 19.1.32. read_dir
      33. 19.1.33. run_child_process
      34. 19.1.34. running_under_wsl
      35. 19.1.35. sleep_ms
      36. 19.1.36. split_by_newlines
      37. 19.1.37. strftime
      38. 19.1.38. strftime_utc
      39. 19.1.39. target_triple
      40. 19.1.40. truncate_left
      41. 19.1.41. truncate_right
      42. 19.1.42. utf16_to_utf8
      43. 19.1.43. version
    2. 19.2. module: wezterm.gui
      ❱
      1. 19.2.1. gui_window_for_mux_window
      2. 19.2.2. screens
    3. 19.3. module: wezterm.mux
      ❱
      1. 19.3.1. all_windows
      2. 19.3.2. get_active_workspace
      3. 19.3.3. get_pane
      4. 19.3.4. get_tab
      5. 19.3.5. get_window
      6. 19.3.6. get_workspace_names
      7. 19.3.7. set_active_workspace
      8. 19.3.8. spawn_window
    4. 19.4. struct: Config
      ❱
      1. 19.4.1. adjust_window_size_when_changing_font_size
      2. 19.4.2. allow_square_glyphs_to_overflow_width
      3. 19.4.3. allow_win32_input_mode
      4. 19.4.4. alternate_buffer_wheel_scroll_speed
      5. 19.4.5. animation_fps
      6. 19.4.6. audible_bell
      7. 19.4.7. automatically_reload_config
      8. 19.4.8. background
      9. 19.4.9. bold_brightens_ansi_colors
      10. 19.4.10. bypass_mouse_reporting_modifiers
      11. 19.4.11. canonicalize_pasted_newlines
      12. 19.4.12. cell_width
      13. 19.4.13. check_for_updates
      14. 19.4.14. clean_exit_codes
      15. 19.4.15. color_schemes
      16. 19.4.16. colors
      17. 19.4.17. cursor_blink_ease_in
      18. 19.4.18. cursor_blink_ease_out
      19. 19.4.19. cursor_blink_rate
      20. 19.4.20. custom_block_glyphs
      21. 19.4.21. daemon_options
      22. 19.4.22. debug_key_events
      23. 19.4.23. default_cursor_style
      24. 19.4.24. default_cwd
      25. 19.4.25. default_domain
      26. 19.4.26. default_gui_startup_args
      27. 19.4.27. default_prog
      28. 19.4.28. default_workspace
      29. 19.4.29. disable_default_quick_select_patterns
      30. 19.4.30. dpi
      31. 19.4.31. enable_csi_u_key_encoding
      32. 19.4.32. enable_kitty_keyboard
      33. 19.4.33. enable_scroll_bar
      34. 19.4.34. enable_tab_bar
      35. 19.4.35. enable_wayland
      36. 19.4.36. exit_behavior
      37. 19.4.37. font
      38. 19.4.38. font_antialias
      39. 19.4.39. font_dirs
      40. 19.4.40. font_hinting
      41. 19.4.41. font_locator
      42. 19.4.42. font_rasterizer
      43. 19.4.43. font_rules
      44. 19.4.44. font_shaper
      45. 19.4.45. font_size
      46. 19.4.46. force_reverse_video_cursor
      47. 19.4.47. foreground_text_hsb
      48. 19.4.48. freetype_interpreter_version
      49. 19.4.49. freetype_load_flags
      50. 19.4.50. freetype_load_target
      51. 19.4.51. freetype_pcf_long_family_names
      52. 19.4.52. freetype_render_target
      53. 19.4.53. front_end
      54. 19.4.54. harfbuzz_features
      55. 19.4.55. hide_tab_bar_if_only_one_tab
      56. 19.4.56. hyperlink_rules
      57. 19.4.57. ime_preedit_rendering
      58. 19.4.58. initial_cols
      59. 19.4.59. initial_rows
      60. 19.4.60. key_map_preference
      61. 19.4.61. key_tables
      62. 19.4.62. launch_menu
      63. 19.4.63. line_height
      64. 19.4.64. min_scroll_bar_height
      65. 19.4.65. mux_env_remove
      66. 19.4.66. native_macos_fullscreen_mode
      67. 19.4.67. pane_focus_follows_mouse
      68. 19.4.68. prefer_egl
      69. 19.4.69. quick_select_alphabet
      70. 19.4.70. quick_select_patterns
      71. 19.4.71. quote_dropped_files
      72. 19.4.72. scroll_to_bottom_on_input
      73. 19.4.73. scrollback_lines
      74. 19.4.74. selection_word_boundary
      75. 19.4.75. set_environment_variables
      76. 19.4.76. show_tab_index_in_tab_bar
      77. 19.4.77. show_update_window
      78. 19.4.78. skip_close_confirmation_for_processes_named
      79. 19.4.79. ssh_backend
      80. 19.4.80. ssh_domains
      81. 19.4.81. status_update_interval
      82. 19.4.82. swallow_mouse_click_on_pane_focus
      83. 19.4.83. swallow_mouse_click_on_window_focus
      84. 19.4.84. swap_backspace_and_delete
      85. 19.4.85. tab_and_split_indices_are_zero_based
      86. 19.4.86. tab_bar_at_bottom
      87. 19.4.87. tab_bar_style
      88. 19.4.88. tab_max_width
      89. 19.4.89. term
      90. 19.4.90. text_blink_ease_in
      91. 19.4.91. text_blink_ease_out
      92. 19.4.92. text_blink_rapid_ease_in
      93. 19.4.93. text_blink_rapid_ease_out
      94. 19.4.94. text_blink_rate
      95. 19.4.95. text_blink_rate_rapid
      96. 19.4.96. tls_clients
      97. 19.4.97. tls_servers
      98. 19.4.98. treat_east_asian_ambiguous_width_as_wide
      99. 19.4.99. treat_left_ctrlalt_as_altgr
      100. 19.4.100. unicode_version
      101. 19.4.101. unix_domains
      102. 19.4.102. unzoom_on_switch_pane
      103. 19.4.103. use_cap_height_to_scale_fallback_fonts
      104. 19.4.104. use_fancy_tab_bar
      105. 19.4.105. use_ime
      106. 19.4.106. use_resize_increments
      107. 19.4.107. visual_bell
      108. 19.4.108. warn_about_missing_glyphs
      109. 19.4.109. window_background_gradient
      110. 19.4.110. window_close_confirmation
      111. 19.4.111. window_decorations
      112. 19.4.112. window_frame
      113. 19.4.113. window_padding
      114. 19.4.114. wsl_domains
      115. 19.4.115. xim_im_name
    5. 19.5. enum: KeyAssignment
      ❱
      1. 19.5.1. ActivateCopyMode
      2. 19.5.2. ActivateKeyTable
      3. 19.5.3. ActivateLastTab
      4. 19.5.4. ActivatePaneByIndex
      5. 19.5.5. ActivatePaneDirection
      6. 19.5.6. ActivateTab
      7. 19.5.7. ActivateTabRelative
      8. 19.5.8. ActivateTabRelativeNoWrap
      9. 19.5.9. AdjustPaneSize
      10. 19.5.10. AttachDomain
      11. 19.5.11. ClearKeyTableStack
      12. 19.5.12. ClearScrollback
      13. 19.5.13. ClearSelection
      14. 19.5.14. CloseCurrentPane
      15. 19.5.15. CloseCurrentTab
      16. 19.5.16. CompleteSelection
      17. 19.5.17. CompleteSelectionOrOpenLinkAtMouseCursor
      18. 19.5.18. Copy
      19. 19.5.19. CopyTo
      20. 19.5.20. DecreaseFontSize
      21. 19.5.21. DetachDomain
      22. 19.5.22. DisableDefaultAssignment
      23. 19.5.23. EmitEvent
      24. 19.5.24. ExtendSelectionToMouseCursor
      25. 19.5.25. Hide
      26. 19.5.26. HideApplication
      27. 19.5.27. IncreaseFontSize
      28. 19.5.28. MoveTab
      29. 19.5.29. MoveTabRelative
      30. 19.5.30. Multiple
      31. 19.5.31. Nop
      32. 19.5.32. OpenLinkAtMouseCursor
      33. 19.5.33. PaneSelect
      34. 19.5.34. Paste
      35. 19.5.35. PasteFrom
      36. 19.5.36. PastePrimarySelection
      37. 19.5.37. PopKeyTable
      38. 19.5.38. QuickSelect
      39. 19.5.39. QuickSelectArgs
      40. 19.5.40. QuitApplication
      41. 19.5.41. ReloadConfiguration
      42. 19.5.42. ResetFontAndWindowSize
      43. 19.5.43. ResetFontSize
      44. 19.5.44. RotatePanes
      45. 19.5.45. ScrollByLine
      46. 19.5.46. ScrollByPage
      47. 19.5.47. ScrollToBottom
      48. 19.5.48. ScrollToPrompt
      49. 19.5.49. ScrollToTop
      50. 19.5.50. Search
      51. 19.5.51. SelectTextAtMouseCursor
      52. 19.5.52. SendKey
      53. 19.5.53. SendString
      54. 19.5.54. Show
      55. 19.5.55. ShowDebugOverlay
      56. 19.5.56. ShowLauncher
      57. 19.5.57. ShowLauncherArgs
      58. 19.5.58. ShowTabNavigator
      59. 19.5.59. SpawnCommandInNewTab
      60. 19.5.60. SpawnCommandInNewWindow
      61. 19.5.61. SpawnTab
      62. 19.5.62. SpawnWindow
      63. 19.5.63. SplitHorizontal
      64. 19.5.64. SplitPane
      65. 19.5.65. SplitVertical
      66. 19.5.66. StartWindowDrag
      67. 19.5.67. SwitchToWorkspace
      68. 19.5.68. SwitchWorkspaceRelative
      69. 19.5.69. ToggleFullScreen
      70. 19.5.70. TogglePaneZoomState
    6. 19.6. object: LocalProcessInfo
    7. 19.7. object: MuxWindow
      ❱
      1. 19.7.1. get_title
      2. 19.7.2. get_workspace
      3. 19.7.3. gui_window
      4. 19.7.4. set_title
      5. 19.7.5. set_workspace
      6. 19.7.6. spawn_tab
      7. 19.7.7. tabs
      8. 19.7.8. tabs_with_info
      9. 19.7.9. window_id
    8. 19.8. object: MuxTab
    9. 19.9. object: MuxPane
    10. 19.10. object: PaneInformation
    11. 19.11. object: TabInformation
    12. 19.12. object: SshDomain
    13. 19.13. object: SpawnCommand
    14. 19.14. object: TlsDomainClient
    15. 19.15. object: TlsDomainServer
    16. 19.16. object: Pane
      ❱
      1. 19.16.1. get_current_working_dir
      2. 19.16.2. get_cursor_position
      3. 19.16.3. get_dimensions
      4. 19.16.4. get_domain_name
      5. 19.16.5. get_foreground_process_info
      6. 19.16.6. get_foreground_process_name
      7. 19.16.7. get_lines_as_text
      8. 19.16.8. get_logical_lines_as_text
      9. 19.16.9. get_title
      10. 19.16.10. get_user_vars
      11. 19.16.11. has_unseen_output
      12. 19.16.12. mux_pane
      13. 19.16.13. pane_id
      14. 19.16.14. paste
    17. 19.17. object: Window
      ❱
      1. 19.17.1. active_key_table
      2. 19.17.2. active_workspace
      3. 19.17.3. composition_status
      4. 19.17.4. copy_to_clipboard
      5. 19.17.5. effective_config
      6. 19.17.6. get_appearance
      7. 19.17.7. get_config_overrides
      8. 19.17.8. get_dimensions
      9. 19.17.9. get_selection_escapes_for_pane
      10. 19.17.10. get_selection_text_for_pane
      11. 19.17.11. leader_is_active
      12. 19.17.12. maximize
      13. 19.17.13. mux_window
      14. 19.17.14. perform_action
      15. 19.17.15. restore
      16. 19.17.16. set_config_overrides
      17. 19.17.17. set_inner_size
      18. 19.17.18. set_position
      19. 19.17.19. set_right_status
      20. 19.17.20. toast_notification
      21. 19.17.21. toggle_fullscreen
      22. 19.17.22. window_id
    18. 19.18. object: WslDomain
    19. 19.19. events: Gui
      ❱
      1. 19.19.1. gui-startup
    20. 19.20. events: Multiplexer
      ❱
      1. 19.20.1. mux-is-process-stateful
      2. 19.20.2. mux-startup
    21. 19.21. events: Window
      ❱
      1. 19.21.1. bell
      2. 19.21.2. format-tab-title
      3. 19.21.3. format-window-title
      4. 19.21.4. open-uri
      5. 19.21.5. update-right-status
      6. 19.21.6. window-config-reloaded
      7. 19.21.7. window-resized

Wez's Terminal Emulator

require wezterm

The wezterm module is the primary module that exposes wezterm configuration and control to your config file.

You will typically place:

local wezterm = require 'wezterm';

at the top of your configuration file to enable it.

Available functions, constants

  • GLOBAL
  • action
  • action_callback
  • add_to_config_reload_watch_list
  • background_child_process
  • battery_info
  • column_width
  • config_dir
  • config_file
  • default_wsl_domains
  • emit
  • enumerate_ssh_hosts
  • executable_dir
  • font
  • font_with_fallback
  • format
  • get_builtin_color_schemes
  • glob
  • gradient_colors
  • home_dir
  • hostname
  • log_error
  • log_info
  • log_warn
  • nerdfonts
  • on
  • open_with
  • pad_left
  • pad_right
  • permute_any_mods
  • permute_any_or_no_mods
  • read_dir
  • run_child_process
  • running_under_wsl
  • sleep_ms
  • split_by_newlines
  • strftime
  • strftime_utc
  • target_triple
  • truncate_left
  • truncate_right
  • utf16_to_utf8
  • version