Skip to content

ShowDebugOverlay

Since: Version 20210814-124438-54e29167

The feature described in this section requires version 20210814-124438-54e29167 of wezterm, or a more recent version.

Overlays the current tab with the debug overlay, which is a combination of a debug log and a lua REPL.

The REPL has the following globals available:

  • wezterm - the wezterm module is pre-imported
  • window - the window object for the current window

The lua context in the REPL is not connected to any global state; you cannot use it to dynamically assign event handlers for example. It is primarily useful for prototyping lua snippets before you integrate them fully into your config.

config.keys = {
  -- CTRL-SHIFT-l activates the debug overlay
  { key = 'L', mods = 'CTRL', action = wezterm.action.ShowDebugOverlay },
}