Wez's Terminal Emulator

wezterm module

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_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