Skip to content

systemslab artifact list

Description List artifacts under an experiment or job
Usage systemslab artifact list [OPTIONS] <--experiment <EXPERIMENT>|--job <JOB>>

Description

The systemslab artifact list command allows listing artifacts attached to an experiment or job.

By default, the output contains the artifact id, the name of the job that emitted it, and the artifact name. This can be configured to instead 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
--experiment The experiment to for which to list artifacts.
--job The job for which to list artifacts.
--run A specific job run for which to list artifacts. If not specified then the latest run will be used.
-H, --no-header Do not emit a table header with the column names.
-f, --fieldid, job, name Specifies fields to be printed when listing artifacts. 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 artifact's unique ID.
  • context-id: The ID of the context that contains the experiment that emitted this artifact.
  • experiment: The name of the experiment that emitted this artifact.
  • experiment-id: The ID of the experiment that emitted the artifact.
  • job: The name of the job that emitted the artifact, if any.
  • job-id: The ID of the job that emitted the artifact, if any.
  • run: The run index of the job that emitted the artifact.
  • name: The name of the artifact.
  • tags: The tags that the artifact was uploaded with.
  • content-type: The content type of the artifact.
-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.