https://github.com/julianburr/sketchtool-cli

CLI wrapped around Sketch.app's sketchtool binary
https://github.com/julianburr/sketchtool-cli

cli sketch sketchtool

Last synced: about 1 month ago
JSON representation

CLI wrapped around Sketch.app's sketchtool binary

• Host: GitHub
• URL: https://github.com/julianburr/sketchtool-cli
• Owner: julianburr
• License: mit
• Created: 2017-08-11T22:45:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-29T06:11:39.000Z (almost 6 years ago)
• Last Synced: 2024-10-03T01:51:24.342Z (3 months ago)
• Topics: cli, sketch, sketchtool
• Language: JavaScript
• Size: 28.3 KB
• Stars: 14
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sketchtool-cli

Simple cli wrapped around Sketch.app's [`sketchtool`](https://www.sketchapp.com/tool/) binary.

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

## Usage

```bin

yarn add sketchtool-cli

```

```js

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

```