Skip to content


Since: Version 20220319-142410-0fcdea07

The functionality described in this section requires version 20220319-142410-0fcdea07 of wezterm, or a more recent version.

Returns true if the Leader Key is active in the window, or false otherwise.

This example shows LEADER in the right status area, and turns the cursor orange, when the leader is active:

local wezterm = require 'wezterm'

wezterm.on('update-right-status', function(window, pane)
  local leader = ''
  if window:leader_is_active() then
    leader = 'LEADER'

return {
  leader = { key = 'a', mods = 'CTRL' },
  colors = {
    compose_cursor = 'orange',

See also: window:composition_status().