systemslab Command-Line Reference

Available Commands

The base commands available are

• systemslab submit
• systemslab evaluate
• systemslab sweep

You can also export and import entities between different SystemsLab servers.

• systemslab export context
• systemslab import context
• systemslab export experiment
• systemslab import experiment

Config File

The systemslab command will automatically look in parent directories to find a config file for some common options. The search path used for this is as follows, in order of decreasing precedence:

• ./.config/systemslab.toml
• ./../.config/systemslab.toml
• ...
• /.config/systemslab.toml
• <CONFDIR>/systemslab/systemslab.toml
• /etc/systemslab/systemslab.toml (if on a unix-based system)

INFO

Which value of <CONFDIR> will be used depends on the OS.

Platform	Value	Example
Linux	$XDG_CONFIG_HOME or $HOME/.config	/home/alice/.config
MacOS	$HOME/Library/Application Support	/Users/Alice/Library/Application Support
Windows	${FOLDERID_RoamingAppData}	C:\Users\Alice\AppData\Roaming

Config Options

systemslab_url

The URL that the systemslab command will use to talk to the SystemsLab server. If not provided via a config file, then it will be necessary to set it by passing the --systemslab-url option or the SYSTEMSLAB_URL environment variable to most subcommands.

INFO

If there is a systemslab server running on the current host then, as a final fallback, the CLI will connect to that server if not otherwise specified. This is detected by looking for a server config file at /etc/systemslab/server.toml.

Common Options

There are a number of options that are accepted by all systemslab subcommands. These are listed both here and in a section on the documentation pages of all subcommands.

Option	Default	Description
--systemslab-url		The URL at which to access the systemslab server.
--color	auto	Controls when color is used in the output. Possible values are auto, always, and never.
--output-format	long	Output format to use when outputting messages. long will result output designed to be human-readable while short is short output meant to be used within scripts.