Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.wezterm.enable

Whether to enable wezterm.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.wezterm.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.wezterm.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.wezterm.package

The wezterm package to use.

Type: package

Default:

pkgs.wezterm

Declared by:

programs.wezterm.colorSchemes

Attribute set of additional color schemes to be written to $XDG_CONFIG_HOME/wezterm/colors, where each key is taken as the name of the corresponding color scheme. See https://wezfurlong.org/wezterm/config/appearance.html#defining-a-color-scheme-in-a-separate-file for more details of the TOML color scheme format.

Type: attribute set of (TOML value)

Default:

{ }

Example:

myCoolTheme = {
  ansi = [
    "#222222" "#D14949" "#48874F" "#AFA75A"
    "#599797" "#8F6089" "#5C9FA8" "#8C8C8C"
  ];
  brights = [
    "#444444" "#FF6D6D" "#89FF95" "#FFF484"
    "#97DDFF" "#FDAAF2" "#85F5DA" "#E9E9E9"
  ];
  background = "#1B1B1B";
  cursor_bg = "#BEAF8A";
  cursor_border = "#BEAF8A";
  cursor_fg = "#1B1B1B";
  foreground = "#BEAF8A";
  selection_bg = "#444444";
  selection_fg = "#E9E9E9";
};

Declared by:

programs.wezterm.extraConfig

Extra configuration written to $XDG_CONFIG_HOME/wezterm/wezterm.lua. See https://wezfurlong.org/wezterm/config/files.html how to configure.

When used together with settings, any table returned from this Lua code is merged into the generated configuration, taking precedence over settings on conflicts. Note that this merge is shallow: a key returned here replaces the entire corresponding value from settings, so nested tables and arrays are not combined. A return statement is optional — code that directly modifies the config variable also works.

Type: strings concatenated with “\n”

Default:

""

Example:

-- Your lua code / config here
local mylib = require 'mylib';
return {
  usemylib = mylib.do_fun();
  font = wezterm.font("JetBrains Mono"),
  font_size = 16.0,
  color_scheme = "Tomorrow Night",
  hide_tab_bar_if_only_one_tab = true,
  default_prog = { "zsh", "--login", "-c", "tmux attach -t dev || tmux new -s dev" },
  keys = {
    {key="n", mods="SHIFT|CTRL", action="ToggleFullScreen"},
  }
}

Declared by:

programs.wezterm.settings

Configuration written to $XDG_CONFIG_HOME/wezterm/wezterm.lua using lib.generators.toLua. Values created with lib.generators.mkLuaInline are rendered as raw Lua expressions, which allows embedding wezterm API calls such as wezterm.font. See https://wezfurlong.org/wezterm/config/files.html for available options.

When this option is set, extraConfig is still supported. Any table returned from the extra Lua code is merged on top of these settings, so extraConfig takes precedence on conflicts.

Type: attribute set of anything

Default:

{ }

Example:

{
  color_scheme = "Catppuccin Mocha";
  font_size = 13;
  hide_tab_bar_if_only_one_tab = true;
  window_padding = {
    left = 0;
    right = 0;
    top = 0;
    bottom = 0;
  };
  font = lib.generators.mkLuaInline ''wezterm.font("JetBrains Mono")'';
}

Declared by: