Breakout Tool Command Line Interface¶

The Breakout Tool is provided as a single executable file. While the executable file has a platform-specific name, such as breakout-windows-x86_amd64.exe, this command reference refers to it as breakout. Open a local terminal or command prompt to run breakout on the command line: you must specify a command and may optionally provide one or more option flags.

::: breakout [flags] COMMAND

Command	Description
config	Creates a default configuration file.
init	Retrieves lab information from the CML server. When a lab ID or unique lab name is provided as a second argument,the Breakout Tool will only retrieve the information forthe specified lab and enable it by default.
run	Runs the tool, reading all configuration information from config files, CLI flags, and environment variables.
ui	Runs the tool with a web interface for both configuring the tool and enabling connections.

Option Flag	Option Argument	Description
`-noverify`	N/A	Overrides the `verify` setting in the configuration. When specified, `breakout` does not verify the TLS certificates.
`-listen`	`ipaddress`	The `address` overrides the listen address. This option can be used to specify, e.g. `-listen 127.0.0.1`, that `breakout` should listen on the localhost IPv4 address instead of the IPv6 in the default configuration.
`-labs`	`filename`	Specifies the name of the lab configuration file to use (default: labs.yaml).
`-config`	`filename`	Specifies the name of the global configuration file to use (default: config.yaml).
`-extralf`	N/A	Sends an extra LF when serial line is opened.
`-port`	`num`	Specifies the local port number to listen on for UI mode (default: `8080`).
`-log_backtrace_at`	`num`	When logging hits line `file:N`, emit a stack trace.
`-log_dir`	`directory`	If non-empty, write log files in this directory.
`-logtostderr`	N/A	Log to standard error instead of files.
`-alsologtostderr`	N/A	Log to standard error in addition to logging to files.
`-stderrthreshold`	`num`	Logs at or above specified threshold go to stderr.
`-v`	`num`	Log level for V logs.
`-vmodule`	`num`	Comma-separated list of pattern=N settings for file-filtered logging.