Appearance
systemslab import workspace
| Description | Import a previously exported SystemsLab workspace. |
|---|---|
| Usage | systemslab import workspace [OPTIONS] <SOURCE> |
Description
The systemslab import workspace command imports an archive made by systemslab export workspace as a new workspace. It creates the workspace with the exported name, description and facets, imports each of its contexts (with their labels) and notebooks, and sets its readme notebook. It always creates a new workspace, and never adds to an existing one.
Everything imported gets a new id. References in the notebooks to the imported contexts, experiments, jobs and artifacts are updated to point to the new copies. References to anything else are left as they are.
If the server rejects a notebook, usually because it refers to something that wasn't imported and doesn't exist on this server, the notebook is imported without what the server can't accept, and a warning lists each change. Mentions become links to the server the export came from. Charts and KPI tables that refer to something missing, and blocks the server doesn't support, become a note saying they were left out.
If the import fails partway, the partly imported workspace is left behind. Archive it with systemslab workspace archive before trying again, or import under another --slug.
Prints the URL of the new workspace, or just its slug with --output-format short.
bash
# Import an export into another server
systemslab import workspace allocators.tar
# Import a copy alongside the original, on the server it came from
systemslab import workspace allocators.tar --slug allocators-copyTIP
systemslab import workspace does not handle compressed tarballs on its own. You can import a compressed tarball by passing it to stdin like so
bash
gzip -dc allocators.tar.gz | systemslab import workspace -Options
| Option | Default | Description |
|---|---|---|
<SOURCE> | The archive made by systemslab export workspace: a tarball, a zip archive, a directory it was unpacked into (the one holding manifest.json), or - to read a tarball from stdin. | |
--slug <SLUG> | The slug of the new workspace. Defaults to the slug of the exported workspace. Importing fails, before anything is created, if a workspace with the slug already exists, as it does when importing back into the server the export came from. | |
-j, --parallel | 1 | How many requests (creating contexts, experiments and notebooks, and uploading artifacts) to run at once, across the whole workspace. Passing 0 will make this use the number of CPUs on the current machine. |
Common Options
| 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. |
Environment Variables
| Variable | Description |
|---|---|
SYSTEMSLAB_URL | Specify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url. |