Skip to content

Command Line

This section documents the wakterm command line.

Note that wakterm --help or wakterm SUBCOMMAND --help will show the precise set of options that are applicable to your installed version of wakterm.

wakterm is deployed with two major executables:

  • wakterm (or wakterm.exe on Windows) - for interacting with wakterm from the terminal
  • wakterm-gui (or wakterm-gui.exe on Windows) - for spawning wakterm from a desktop environment

You will typically use wakterm when scripting wakterm; it knows when to delegate to wakterm-gui under the covers.

If you are setting up a launcher for wakterm to run in the Windows GUI environment then you will want to explicitly target wakterm-gui so that Windows itself doesn't pop up a console host for its logging output.

Note

wakterm-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 wakterm.exe --help to see information about the various commands; it will delegate to wakterm-gui.exe when appropriate.

Synopsis

wakterm
http://github.com/wakamex/wakterm

Usage: wakterm [OPTIONS] [COMMAND]

Commands:
  start                  Start the GUI, optionally running an alternative
                             program [aliases: -e]
  ssh                    Establish an ssh session
  serial                 Open a serial port
  connect                Connect to wakterm multiplexer
  ls-fonts               Display information about fonts
  show-keys              Show key assignments
  cli                    Interact with experimental mux server
  imgcat                 Output an image to the terminal
  set-working-directory  Advise the terminal of the current working
                             directory by emitting an OSC 7 escape sequence
  record                 Record a terminal session as an asciicast
  replay                 Replay an asciicast terminal session
  shell-completion       Generate shell completion information
  help                   Print this message or the help of the given
                             subcommand(s)

Options:
  -n, --skip-config
          Skip loading wakterm.lua
      --config-file <CONFIG_FILE>
          Specify the configuration file to use, overrides the normal
          configuration file resolution
      --config <name=value>
          Override specific configuration values
  -h, --help
          Print help
  -V, --version
          Print version