Skip to content

systemslab experiment list

Description List experiments.
Usage systemslab experiment list [OPTIONS]

Description

The systemslab experiment list command lists experiments on the SystemsLab server with optional filtering.

By default, the output contains the experiment id, name, state, and creation time. This can be configured to show a number of other fields instead. See the documentation of the --field argument for a full list.

For use in scripts you will want to use the --no-align flag along with (potentially) the --record-separator and --field-separator flags.

Options

OptionDefaultDescription
--name <REGEX> Filter experiments by name. The value is interpreted as a POSIX regular expression.
--state <STATE> Filter experiments by state. Valid values are: pending, success, failure, error, cancelled.
--context <UUID> Only list experiments attached to this context.
--limit <N>100 Maximum number of experiments to return.
--before <UUID> Only list experiments that came before this experiment ID. Useful for pagination.
--after <UUID> Only list experiments that came after this experiment ID.
-H, --no-header Do not emit a table header with the column names.
-f, --fieldid, name, state, created-at Specifies fields to be printed when listing experiments. This flag can be provided multiple times to specify multiple fields to show. The defaults are only used if no fields are requested. Valid fields which can be requested are:
  • id: The experiment's unique ID.
  • name: The user-provided name of the experiment.
  • state: The current state of the experiment.
  • created-at: The time at which the experiment was created.
  • completed-at: The time at which the experiment completed.
  • run: The latest re-run index of the experiment.
-A, --no-align Switches to unaligned output mode.
-F,
--field-separator
" " Use this separator as the field separator when emitting unaligned output.
-R,
--record-separator
"\n" Use this separator as the record separator for unaligned output.

Common Options

OptionDefaultDescription
--systemslab-url The URL at which to access the systemslab server.
--colorauto Controls when color is used in the output. Possible values are auto, always, and never.
--output-formatlong 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.

Environment Variables

VariableDescription
SYSTEMSLAB_URLSpecify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url.