Meta tags:
description=Wez s Terminal Emulator;

Headings (most frequently used words):

wezterm, features,

Text of the page (most frequently used words):
#wezterm (42), object (23), module (18), reference (12), pane (11), window (11), color (9), and (8), terminal (7), config (7), activate (6), tab (6), cli (6), events (6), gui (6), wez (5), features (5), configuration (5), full (5), download (5), get (5), lua (5), list (4), font (4), emulator (4), help (4), title (4), format (4), mux (4), time (4), enum (4), with (3), macos (3), the (3), search (3), hyperlinks (3), schemes (3), windows (3), multiplexer (3), set (3), active_pane (3), get_title (3), parse (3), url (3), key (3), for (2), click (2), panes (2), tabs (2), mouse (2), scrollback (2), linux (2), freebsd (2), netbsd (2), sponsor (2), change (2), log (2), ssh (2), show (2), serial (2), fonts (2), split (2), text (2), new (2), direction (2), focus (2), changed (2), update (2), status (2), startup (2), window_id (2), get_dimensions (2), get_appearance (2), active_tab (2), paste (2), set_title (2), muxtab (2), muxwindow (2), muxdomain (2), copymodeassignment (2), copy (2), keyassignment (2), json_encode (2), serde (2), procinfo (2), plugin (2), colors (2), options (2), from (2), recipes (2), binding (2), keyboard (2), mode (2), made, material, mkdocs, copyright, 2018, present, furlong, next, back, top, screenshot, running, vim, these, docs, are, searchable, press, magnifying, glass, icon, function, looking, can, found, here, emoji, fallback, true, dynamic, ligatures, multiplex, local, remote, hosts, native, runs, powerful, cross, platform, written, implemented, rust, table, contents, contributing, getting, troubleshooting, what, escape, sequences, start, keys, working, directory, replay, record, imgcat, connect, zoom, spawn, send, rename, workspace, move, clients, kill, adjust, size, resized, reloaded, user, var, right, open, uri, button, bell, augment, command, palette, process, stateful, attached, wsldomain, toggle_fullscreen, toast_notification, set_right_status, set_position, set_left_status, set_inner_size, set_config_overrides, restore, perform_action, mux_window, maximize, leader_is_active, keyboard_modifiers, is_focused, get_selection_text_for_pane, get_selection_escapes_for_pane, get_config_overrides, effective_config, current_event, copy_to_clipboard, composition_status, active_workspace, active_key_table, send_text, send_paste, pane_id, mux_pane, move_to_new_window, move_to_new_tab, is_alt_screen_active, inject_output, has_unseen_output, get_user_vars, get_tty_name, get_text_from_semantic_zone, get_text_from_region, get_semantic_zones, get_semantic_zone_at, get_progress, get_metadata, get_logical_lines_as_text, get_lines_as_text, get_lines_as_escapes, get_foreground_process_name, get_foreground_process_info, get_domain_name, get_cursor_position, get_current_working_dir, tlsdomainserver, tlsdomainclient, sun_times, format_utc, spawncommand, sshdomain, tabinformation, paneinformation, tab_id, set_zoomed, rotate_counter_clockwise, rotate_clockwise, panes_with_info, get_size, get_pane_direction, tabs_with_info, spawn_tab, set_workspace, gui_window, get_workspace, state, name, label, is_spawnable, has_any_panes, domain_id, detach, attach, localprocessinfo, execdomain, triad, srgb_u8, square, saturate_fixed, saturate, linear_rgba, lighten_fixed, lighten, laba, hsla, desaturate_fixed, desaturate, delta_e, darken_fixed, darken, contrast_ratio, complement_ryb, complement, adjust_hue_fixed_ryb, adjust_hue_fixed, setselectionmode, priormatchpage, priormatch, nextmatchpage, nextmatch, moveup, movetoviewporttop, movetoviewportmiddle, movetoviewportbottom, movetostartofnextline, movetostartoflinecontent, movetostartofline, movetoselectionotherendhoriz, movetoselectionotherend, movetoscrollbacktop, movetoscrollbackbottom, movetoendoflinecontent, moveright, moveleft, moveforwardwordend, moveforwardword, moveforwardsemanticzoneoftype, moveforwardsemanticzone, movedown, movebackwardword, movebackwardsemanticzoneoftype, movebackwardsemanticzone, editpattern, cyclematchtype, close, clearselectionmode, clearpattern, acceptpattern, togglepanezoomstate, togglefullscreen, togglealwaysontop, togglealwaysonbottom, switchworkspacerelative, switchtoworkspace, startwindowdrag, splitvertical, splitpane, splithorizontal, spawnwindow, spawntab, spawncommandinnewwindow, spawncommandinnewtab, showtabnavigator, showlauncherargs, showlauncher, showdebugoverlay, setwindowlevel, setpanezoomstate, sendstring, sendkey, selecttextatmousecursor, scrolltotop, scrolltoprompt, scrolltobottom, scrollbypage, scrollbyline, scrollbycurrenteventwheeldelta, rotatepanes, resetterminal, resetfontsize, resetfontandwindowsize, reloadconfiguration, quitapplication, quickselectargs, quickselect, promptinputline, popkeytable, pasteprimaryselection, pastefrom, paneselect, openlinkatmousecursor, nop, multiple, movetabrelative, movetab, inputselector, increasefontsize, hideapplication, hide, extendselectiontomousecursor, emitevent, disabledefaultassignment, detachdomain, decreasefontsize, copyto, confirmation, completeselectionoropenlinkatmousecursor, completeselection, closecurrenttab, closecurrentpane, clearselection, clearscrollback, clearkeytablestack, charselect, attachdomain, adjustpanesize, activatewindowrelativenowrap, activatewindowrelative, activatewindow, activatetabrelativenowrap, activatetabrelative, activatetab, activatepanedirection, activatepanebyindex, activatelasttab, activatekeytable, activatecopymode, activatecommandpalette, parse_rfc3339, now, call_after, yaml_encode, yaml_decode, toml_encode_pretty, toml_encode, toml_decode, json_encode_pretty, json_decode, pid, get_info_for_pid, executable_path_for_pid, current_working_dir_for_pid, update_all, require, spawn_window, set_default_domain, set_active_workspace, rename_workspace, get_workspace_names, get_window, get_tab, get_pane, get_domain, get_active_workspace, all_windows, all_domains, screens, gui_windows, gui_window_for_mux_window, enumerate_gpus, default_keys, default_key_tables, save_scheme, load_terminal_sexy_scheme, load_scheme, load_base16_scheme, gradient, get_default_colors, get_builtin_schemes, from_hsla, extract_colors_from_image, version, utf16_to_utf8, truncate_right, truncate_left, to_string, target_triple, strftime_utc, strftime, split_by_newlines, sleep_ms, shell_split, shell_quote_arg, shell_join_args, running_under_wsl, run_child_process, reload_configuration, read_dir, permute_any_or_no_mods, permute_any_mods, pad_right, pad_left, open_with, nerdfonts, log_warn, log_info, log_error, json_parse, hostname, home_dir, has_action, gradient_colors, glob, get_builtin_color_schemes, font_with_fallback, executable_dir, enumerate_ssh_hosts, emit, default_wsl_domains, default_ssh_domains, default_hyperlink_rules, config_file, config_dir, config_builder, column_width, battery_info, background_child_process, add_to_config_reload_watch_list, action_callback, action, global, xim_im_name, wsl_domains, window_padding, window_frame, window_decorations, window_content_alignment, window_close_confirmation, window_background_opacity, window_background_image_hsb, window_background_image, window_background_gradient, win32_system_backdrop, win32_acrylic_accent_color, webgpu_preferred_adapter, webgpu_power_preference, webgpu_force_fallback_adapter, wayland_window_background_blur, warn_about_missing_glyphs, visual_bell, use_resize_increments, use_ime, use_fancy_tab_bar, use_cap_height_to_scale_fallback_fonts, unzoom_on_switch_pane, unix_domains, unicode_version, underline_thickness, underline_position, ulimit_nproc, ulimit_nofile, ui_key_cap_rendering, treat_left_ctrlalt_as_altgr, treat_east_asian_ambiguous_width_as_wide, tls_servers, tls_clients, tiling_desktop_environments, text_min_contrast_ratio, text_blink_rate_rapid, text_blink_rate, text_blink_rapid_ease_out, text_blink_rapid_ease_in, text_blink_ease_out, text_blink_ease_in, term, tab_max_width, tab_bar_style, tab_bar_at_bottom, tab_and_split_indices_are_zero_based, switch_to_last_active_tab_when_closing_tab, swap_backspace_and_delete, swallow_mouse_click_on_window_focus, swallow_mouse_click_on_pane_focus, strikethrough_position, status_update_interval, ssh_domains, ssh_backend, skip_close_confirmation_for_processes_named, show_update_window, show_tabs_in_tab_bar, show_tab_index_in_tab_bar, show_new_tab_button_in_tab_bar, show_close_tab_button_in_tabs, set_environment_variables, serial_ports, selection_word_boundary, scrollback_lines, scroll_to_bottom_on_input, reverse_video_cursor_min_contrast, quote_dropped_files, quit_when_all_windows_are_closed, quick_select_remove_styling, quick_select_patterns, quick_select_alphabet, prefer_to_spawn_tabs, prefer_egl, pane_select_font, pane_focus_follows_mouse, notification_handling, normalize_output_to_unicode_nfc, native_macos_fullscreen_mode, mux_env_remove, mux_enable_ssh_agent, mouse_wheel_scrolls_tabs, min_scroll_bar_height, max_fps, macos_window_background_blur, macos_fullscreen_extend_behind_notch, macos_forward_to_ime_modifier_mask, log_unknown_escape_sequences, line_height, launcher_alphabet, launch_menu, key_tables, key_map_preference, kde_window_background_blur, integrated_title_buttons, integrated_title_button_style, integrated_title_button_color, integrated_title_button_alignment, initial_rows, initial_cols, ime_preedit_rendering, hyperlink_rules, hide_tab_bar_if_only_one_tab, hide_mouse_cursor_when_typing, harfbuzz_features, front_end, freetype_render_target, freetype_pcf_long_family_names, freetype_load_target, freetype_load_flags, freetype_interpreter_version, foreground_text_hsb, force_reverse_video_cursor, font_size, font_shaper, font_rules, font_rasterizer, font_locator, font_hinting, font_dirs, font_antialias, exit_behavior_messaging, exit_behavior, enable_wayland, enable_tab_bar, enable_scroll_bar, enable_kitty_keyboard, enable_csi_u_key_encoding, dpi, display_pixel_geometry, disable_default_quick_select_patterns, disable_default_mouse_bindings, detect_password_input, default_workspace, default_ssh_auth_sock, default_prog, default_mux_server_domain, default_gui_startup_args, default_domain, default_cwd, default_cursor_style, debug_key_events, daemon_options, custom_block_glyphs, cursor_thickness, cursor_blink_rate, cursor_blink_ease_out, cursor_blink_ease_in, command_palette_rows, command_palette_line_height, command_palette_font_size, command_palette_font, command_palette_fg_color, command_palette_bg_color, color_schemes, clean_exit_codes, check_for_updates, char_select_font_size, char_select_font, char_select_fg_color, char_select_bg_color, cell_widths, cell_width, canonicalize_pasted_newlines, bypass_mouse_reporting_modifiers, bold_brightens_ansi_colors, background, automatically_reload_config, audible_bell, anti_alias_custom_block_glyphs, animation_fps, alternate_buffer_wheel_scroll_speed, allow_win32_input_mode, allow_square_glyphs_to_overflow_width, adjust_window_size_when_changing_font_size, workspaces, sessions, passing, data, use, directly, plugins, encoding, default, assignments, tables, concepts, shaping, launching, programs, appearance, build, source, multiplexing, ports, arduino, iterm, image, protocol, shell, integration, quick, select, initializing, skip, content,

Text of the page (random words):
wezterm wez s terminal emulator skip to content wez s terminal emulator wezterm initializing search wezterm wezterm wezterm download configuration full config lua reference cli reference reference get help change log sponsor wez s terminal emulator wezterm wezterm wezterm wezterm 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_line_height 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 wayland_window_background_blur webgpu_force_fallback_adapter webgpu_power_preference webgpu_preferred_adapter win32_acrylic_accent_color win32_system_backdrop window_background_gradient window_background_image window_background_image_hsb window_background_opacity window_close_confirmation window_content_alignment window_decorations window_frame window_padding wsl_domains xim_im_name module wezterm module wezterm 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 wezterm color module wezterm 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 wezterm gui module wezterm gui default_key_tables default_keys enumerate_gpus get_appearance gui_window_for_mux_window gui_windows screens module wezterm mux module wezterm 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 wezterm plugin module wezterm plugin list require update_all module wezterm procinfo module wezterm procinfo current_working_dir_for_pid executable_path_for_pid get_info_for_pid pid module wezterm serde module wezterm serde json_decode json_encode json_encode_pretty toml_decode toml_encode toml_encode_pretty yaml_decode yaml_encode module wezterm time module wezterm time call_after now parse parse_rfc3339 module wezterm url module wezterm 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 wezterm cli wezterm 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 wezterm connect wezterm imgcat wezterm ls fonts wezterm record wezterm replay wezterm serial wezterm set working directory wezterm show keys wezterm ssh wezterm start reference reference escape sequences what is a terminal get help get help troubleshooting f a q getting help contributing change log sponsor table of contents features wezterm wezterm is a powerful cross platform terminal emulator and multiplexer written by wez and implemented in rust download features runs on linux macos windows 10 freebsd and netbsd multiplex terminal panes tabs and windows on local and remote hosts with native mouse and scrollback ligatures color emoji and font fallback with true color and dynamic color schemes hyperlinks a full list of features can be found here looking for a configuration reference these docs are searchable press s or click on the magnifying glass icon to activate the search function screenshot of wezterm on macos running vim back to top next features copyright 2018 present wez furlong made with material for mkdocs