Skip to main content
WezTerm provides a comprehensive command-line interface for interacting with the terminal emulator. This section documents all available commands and their options.

​
Executables

WezTerm is deployed with two major executables:
  • wezterm (or wezterm.exe on Windows) - for interacting with wezterm from the terminal
  • wezterm-gui (or wezterm-gui.exe on Windows) - for spawning wezterm from a desktop environment
You will typically use wezterm when scripting wezterm; it knows when to delegate to wezterm-gui under the covers. If you are setting up a launcher for wezterm to run in the Windows GUI environment then you will want to explicitly target wezterm-gui so that Windows itself doesn’t pop up a console host for its logging output.
wezterm-gui.exe --help will not output anything to a console when run on Windows systems, because it runs in the Windows GUI subsystem and has no connection to the console. You can use wezterm.exe --help to see information about the various commands; it will delegate to wezterm-gui.exe when appropriate.

​
Synopsis

wezterm [OPTIONS] [COMMAND]

​
Global Options

These options apply to all wezterm commands:
​
-n, --skip-config
flag
Skip loading wezterm.lua configuration file
​
--config-file
path
Specify the configuration file to use, overrides the normal configuration file resolution
​
--config
name=value
Override specific configuration values. Can be specified multiple times.Example: wezterm --config font_size=14 --config enable_tab_bar=false start
​
-h, --help
flag
Print help information
​
-V, --version
flag
Print version information

​
Available Commands

start

Start the GUI, optionally running an alternative program

ssh

Establish an SSH session

connect

Connect to wezterm multiplexer

serial

Open a serial port

ls-fonts

Display information about fonts

imgcat

Output an image to the terminal

show-keys

Show key assignments

set-working-directory

Advise the terminal of the current working directory

record

Record a terminal session as an asciicast

replay

Replay an asciicast terminal session

​
Getting Help

You can get help for any command by running: 
wezterm <command> --help
For example: 
wezterm start --help
wezterm ssh --help