workshop (CLI)

Workshop includes an eponymous command-line utility, workshop; it is the daily go-to instrument for regular users, with a set of commands that govern the entire lifecycle of a workshop.

There are several categories of commands that vary by their purpose:

Actions	Commands	What they do
Create, update, delete	launch, refresh, remove, restore, start, stop	Control a workshop’s existence and runtime state, from first launch to refresh, restore, and removal.
Customize	sketch-sdk, sketches	Augment a workshop with project-specific customizations through sketch SDKs.
Enumerate	info, list	List the workshops in a project and inspect their current details.
Track changes	changes, tasks	Review recent changes to the workshops in a project and the tasks that make up each change.
Manage connections	connect, connections, disconnect, remount	Wire interface plugs and slots between SDKs, list existing connections, and remount their sources.
Run shell commands	exec, shell	Run an ad-hoc command in a workshop or open an interactive shell inside it.
Run named actions	actions, run	List and invoke the named actions defined in a workshop’s actions: section.
Manage warnings	okay, warnings	List warnings raised by the daemon and acknowledge them.

For an end-to-end example of putting these commands to use, refer to the tutorial.

Note

The utility talks to the Workshop daemon, workshopd, via a REST API, so alternatives are possible and, in fact, encouraged.

See also

Reference:

• Command-line interfaces

Tutorial:

• Get started with workshops