wezterm/docs/config/lua/keyassignment/ShowDebugOverlay.md

ShowDebugOverlay

Since: 20210814-124438-54e29167

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.

local wezterm = require 'wezterm'

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