Add-Assistant button

We’re retiring the Assistants feature later in 2023 — but you can still use it with older versions of Sketch, or with the Command Line Interface. Find out more

Sketch Assistants listed on sketch.com feature an Add Assistant button that automatically adds the latest version of an Assistant to the currently open Sketch document. You’re free to create Add Assistant buttons on your own websites and documentation pages too.

The buttons work by opening a url using the sketch:// protocol in the following format,

sketch://add-assistant?url=<tarball-url>

The <tarball-url> query parameter is a full download url to your Assistant packaged as a *.tgz tarball.

💡 There are instructions about how to acquire a tarball url for an Assistant published on npm in our publishing guide.