systemslab workspace edit

Description	Change a workspace's name, slug, description or readme notebook.
Usage	systemslab workspace edit [OPTIONS] <WORKSPACE>

Description

The systemslab workspace edit command changes a workspace after it has been created. Only the options that are given change, and at least one is needed. It prints the URL of the workspace's page, or just its slug with --output-format short.

A common use is to set the readme once the notebook has been written:

systemslab workspace edit allocator-sweep --readme <NOTEBOOK-ID>

Rename the workspace and read its new description from a file:

systemslab workspace edit allocator-sweep --name "Allocator sweep (final)" \
    --description-file summary.md

Changing the slug follows the same rules as systemslab workspace create. Afterwards the old slug no longer finds the workspace.

Options

Option	Default	Description
<WORKSPACE>		The workspace's slug or id.
--name <NAME>		A new human-readable name for the workspace.
--slug <SLUG>		A new slug for the workspace. The old slug stops working.
--description <DESCRIPTION>		A new markdown description of what the workspace is for. Conflicts with --description-file.
--description-file <PATH>		Read the new markdown description from this file. Pass - to read from stdin.
--readme <NOTEBOOK-ID>		Make this notebook the workspace's readme. The notebook doesn't have to be in the workspace. Conflicts with --clear-readme.
--clear-readme		Remove the workspace's readme notebook. The notebook itself is not deleted.

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.