Skip to content

Manage addons

Search, install, update, remove, and push addons (plugins, components, templates, themes) from the hub.

All addon commands accept --slidesk-link-url <url> to point to a custom hub instance (default: https://slidesk.link), see Host your own slidesk.link.

Addons are named @author/name. @author__name is accepted too: it is the name of the installed directory.

slidesk plugin search steps
slidesk component search qrcode
slidesk template search split
slidesk theme search dark

Install

slidesk plugin install @gouz/steps
slidesk component install @gouz/qrcode
slidesk template install @gouz/split
slidesk theme install @gouz/night

Plugins, templates and themes land in their own directory, for instance plugins/@gouz__steps/. Components are dropped into components/ as <user>__<name>.mjs, for instance components/@gouz__qrcode.mjs.

Installing an addon that is already there replaces it, files of the previous version included.

Install from a git repository

An addon that is not on the hub installs from its git repository:

slidesk theme install https://github.com/someone/my-theme.git
slidesk plugin install git@github.com:someone/my-plugin.git

SliDesk clones it with your git, so a private repository works with your credentials. The repository is the addon itself: theme.json, plugin.json or template.json at its root, a .mjs anywhere for a component. It is installed under the name of the repository, themes/my-theme/, or for a plugin under the name its plugin.json gives its files (plugins/<name>/…).

The clone keeps its .git: updating the addon force-pulls its repository, and drops the changes you made to it.

slidesk theme update my-theme
slidesk update            # the addons from the hub and from git

To freeze an addon before a conference, add a branch, a tag or a commit after #. Updates keep it: a tag or a commit stays where it is, a branch follows its last commit.

slidesk theme install https://github.com/someone/my-theme.git#v1.2.0
slidesk theme update https://github.com/someone/my-theme.git   # back to the default branch

A component is a single .mjs, without its .git: update it with its URL, slidesk component update https://github.com/someone/my-component.git.

present does not serve the .git of an addon, save does not export it, and push does not send it.

Update

slidesk plugin update @gouz/steps
slidesk component update @gouz/qrcode
slidesk template update @gouz/split
slidesk theme update @gouz/night

Or update every addon of the talk at once, or every addon of one kind:

slidesk update
slidesk update plugins

The installed version is only replaced once the new one is downloaded: when the hub cannot be reached, you keep the version you had.

Remove

slidesk plugin remove @gouz/steps
slidesk component remove @gouz/qrcode
slidesk template remove @gouz/split
slidesk theme remove @gouz/night

When a command fails (addon not found on the hub, hub unreachable, nothing installed under that name), it prints why and exits with code 1.

Push (share your own)

Requires slidesk link login first.

slidesk plugin push my-plugin
slidesk component push my-component
slidesk template push my-template
slidesk theme push my-theme

Run it from the directory that holds the addon: my-plugin/, my-template/ and my-theme/ are directories, while my-component stands for my-component.mjs.

A plugin directory holds a plugin.json, a template one a template.json, a theme one a theme.json ({} is enough for the last two): without it, the addon cannot be installed from git, and a plugin cannot be removed with remove.