Skip to content

systemslab notebook list ​

Description List notebooks, most recently updated first.
Usage systemslab notebook list [OPTIONS]

Description ​

The systemslab notebook list command prints the id, revision, last update time and title of each notebook on the SystemsLab server. Pass an id to systemslab notebook pull to download a notebook.

To find the write-ups about an experiment or context, filter by the entities a notebook references:

sh
systemslab notebook list --references 0192f4e0-0000-7100-8000-000000000002

Options ​

OptionDefaultDescription
--search <SEARCH>Only list notebooks whose title matches this text. Matching is case-insensitive and every word must appear.
--references <ID> Only list notebooks that mention or chart this context, experiment, job, artifact or report, or have it as their default scope. Takes a single bare UUID.
--limit <LIMIT>The maximum number of notebooks to list. Defaults to 100.
--offset <OFFSET> How many notebooks to skip before listing, to see the ones after the first --limit, e.g. --limit 100 --offset 100 for the second page. Defaults to 0.
-H, --no-headerDon't print the table header.

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.