Wakterm docs

Command Line#

This section documents the wakterm command line interface.

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

wakterm is deployed with two executables:

  • wakterm (or wakterm.exe on Windows): command line interface for scripting, multiplexing, and agent commands
  • wakterm-gui (or wakterm-gui.exe on Windows): desktop GUI client

You will typically use wakterm when scripting or interacting with wakterm from a terminal. 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, target wakterm-gui so Windows does not open an extra console host for logging.

Note that wakterm-gui.exe --help will not output anything to a console when run on Windows systems because it runs in the Windows GUI subsystem. Use wakterm.exe --help to see command line help on Windows.

Key subcommands#

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
  agent                  Start and interact with agents
  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

Pages