> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/wezterm/wezterm/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Overview

> Command line interface overview and common options for WezTerm

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.

<Note>
  `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.
</Note>

## Synopsis

```bash theme={null}
wezterm [OPTIONS] [COMMAND]
```

## Global Options

These options apply to all wezterm commands:

<ParamField path="-n, --skip-config" type="flag">
  Skip loading wezterm.lua configuration file
</ParamField>

<ParamField path="--config-file" type="path">
  Specify the configuration file to use, overrides the normal configuration file resolution
</ParamField>

<ParamField path="--config" type="name=value">
  Override specific configuration values. Can be specified multiple times.

  Example: `wezterm --config font_size=14 --config enable_tab_bar=false start`
</ParamField>

<ParamField path="-h, --help" type="flag">
  Print help information
</ParamField>

<ParamField path="-V, --version" type="flag">
  Print version information
</ParamField>

## Available Commands

<CardGroup cols={2}>
  <Card title="start" icon="play" href="/cli/start">
    Start the GUI, optionally running an alternative program
  </Card>

  <Card title="ssh" icon="server" href="/cli/ssh">
    Establish an SSH session
  </Card>

  <Card title="connect" icon="link" href="/cli/connect">
    Connect to wezterm multiplexer
  </Card>

  <Card title="serial" icon="plug" href="/cli/serial">
    Open a serial port
  </Card>

  <Card title="ls-fonts" icon="font" href="/cli/ls-fonts">
    Display information about fonts
  </Card>

  <Card title="imgcat" icon="image" href="/cli/imgcat">
    Output an image to the terminal
  </Card>

  <Card title="show-keys" icon="keyboard" href="/cli/show-keys">
    Show key assignments
  </Card>

  <Card title="set-working-directory" icon="folder" href="/cli/set-working-directory">
    Advise the terminal of the current working directory
  </Card>

  <Card title="record" icon="circle" href="/cli/record">
    Record a terminal session as an asciicast
  </Card>

  <Card title="replay" icon="play-circle" href="/cli/replay">
    Replay an asciicast terminal session
  </Card>
</CardGroup>

## Getting Help

You can get help for any command by running:

```bash theme={null}
wezterm <command> --help
```

For example:

```bash theme={null}
wezterm start --help
wezterm ssh --help
```