Skip to content
CLI wrapped around Sketch.app's sketchtool binary
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
.gitignore
LICENSE
README.md
index.js
package.json
yarn.lock

README.md

sketchtool-cli

Simple cli wrapped around Sketch.app's sketchtool binary.

Will always use the binary installed with Sketch, so whenever Sketch updates, it takes the updated version of sketchtool as well.

Usage

yarn add sketchtool-cli
const sketchtool = require('sketchtool-cli');

// Check if sketchtool binary is available
sketchtool.check();

// Get current version (string)
sketchtool.version();  // = sketchtool --version

// Get path to sketch plugin folder
sketchtool.pluginFolder();  // = sketchtool show plugins

// Execute any command
sketchtool.run('dump ~/myFile.sketch');

// Abstractions for most commonly used commands
sketchtool.dump('~/myFile.sketch');  // = sketchtool dump ~/myFile.sketch
sketchtool.list('pages', '~/myFile.sketch');  // = sketchtool list pages ~/myFile.sketch
You can’t perform that action at this time.