Skip to content

systemslab notebook pull ​

Description Download a notebook as a markdown file.
Usage systemslab notebook pull [OPTIONS] <ID>

Description ​

The systemslab notebook pull command writes a notebook to a markdown file (or standard output) so that it can be edited locally and sent back with systemslab notebook push.

The file starts with YAML front matter recording the notebook's id, revision and title, and its default context or experiment if it has one:

markdown
---
id: 0192f4e0-0000-7f00-8000-000000000009
revision: 4
title: Allocator results
---

# Summary

The [baseline](/experiment/0192f4e0-0000-7100-8000-000000000002) was 18%
slower.

Keep the id and revision lines: push uses them to update the right notebook and to detect conflicting changes. The body is written in the notebook markdown dialect, described in docs/notebooks.md.

Options ​

OptionDefaultDescription
<ID>The id of the notebook to download.
-o, --output <FILE> The file to write the notebook to. Overwritten if it exists. Without it the notebook is printed to standard output; pass `-o` if you intend to edit and push it.

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.