Start extending Sketch…
sketchtool command-line interface to export assets, inspect documents and run plugins.
Generate, modify and process Sketch files directly with the open JSON file format.
Integrate Sketch into your workflows with the
sketch:// URL scheme.
Run a script
- Open a new or existing file in Sketch
- Select Run Script… from the Plugins menu or use the keyboard shortcut
control + shift + kto bring up the code editor
- Paste in the code below
- Select Run
const sketch = require('sketch') sketch.UI.message('Hello Sketch 👋')
Publish a plugin
Use the Sketch Plugin Manager
skpm to publish a new plugin or an update of an existing one. This adds your plugin automatically to the Sketch Plugin Directory for review before being listed on the Sketch website.
Export assets automatically
Create assets with a single command with the Sketch command-line interface
sketchtool. Quickly generate files for all exportable layers, slices, artboards or entire pages in as many different resolutions as you want.
- Open a new file in Sketch
- Add a shape or anything else to the canvas
- Save the file locally, e.g. App.sketch on your Desktop
- Open Terminal and run the following command, which looks up the
sketchtoolbundled with Sketch and exports all pages of App.sketch.
This will generate an image file called Page 1.png in the same folder you ran the command in.
SKETCH=$(mdfind kMDItemCFBundleIdentifier == 'com.bohemiancoding.sketch3' | head -n 1) && \ "$SKETCH/Contents/Resources/sketchtool/bin/sketchtool" export pages ~/Desktop/App.sketch
Not a developer? Submit an idea
Although you’ll need some programming experience to extend Sketch yourself, you can also submit an idea to let us and the community know how you’d like to see Sketch extended.
Take a look at the list of plugins the community has already built.
We’re here to help
Join our developer forum to discuss your questions and code.
Explore some sample plugins built by Sketch.
Get in touch with us.