show-keys command displays the key assignments configured in your WezTerm instance, making it easy to discover and document your keyboard shortcuts.
Synopsis
Description
Displays all key bindings configured in your WezTerm configuration. This is useful for:- Discovering what key bindings are available
- Debugging key binding conflicts
- Generating documentation for your configuration
- Exporting key bindings in Lua format
Options
Show the keys as Lua config statements.Instead of a human-readable table, outputs valid Lua code that can be used in your
wezterm.lua configuration file.Example:In Lua mode, show only the named key table.WezTerm supports multiple key tables for different modes (like tmux’s prefix key). Use this option to show bindings for a specific table.Requires:
--lua flagExample:Examples
Show all key bindings
Export key bindings as Lua
Show specific key table
Save key bindings to a file
Check for specific binding
Compare key bindings between configs
Understanding Key Tables
WezTerm supports multiple key tables for modal key bindings. Common key tables include:- Default table: Active by default
- copy_mode: Active when in copy/search mode
- search_mode: Active when searching
- Custom tables: You can define your own
Example with key tables in wezterm.lua:
Common Key Binding Modifiers
CTRL- Control keySHIFT- Shift keyALT- Alt/Option keySUPER- Windows/Command keyLEADER- Leader key (if configured)
|:
CTRL|SHIFTCTRL|ALTSUPER|SHIFT
Use Cases
Documentation
Generate documentation for your team:Debugging Conflicts
If a key binding isn’t working:Configuration Backup
Before making changes:Learning Default Bindings
If you haven’t customized your config yet:Sharing Configuration
Export your key bindings to share with others:Default Key Bindings
WezTerm comes with sensible defaults. Some common ones include:CTRL+SHIFT+T- New tabCTRL+SHIFT+N- New windowCTRL+SHIFT+W- Close tabCTRL+SHIFT+C- Copy (when text is selected)CTRL+SHIFT+V- PasteCTRL+SHIFT+F- SearchCTRL+SHIFT+L- Show launcherCTRL+Tab- Next tabCTRL+SHIFT+Tab- Previous tab
wezterm show-keys to see the complete list for your configuration.
Customizing Key Bindings
To customize key bindings, edit yourwezterm.lua:
Related
- wezterm ls-fonts - Display font information
- WezTerm Key Binding Configuration Documentation