https://github.com/vil-lang/sketchtool-api

JavaScript API for sketchtool.
https://github.com/vil-lang/sketchtool-api

api sketch-app sketchtool

Last synced: about 2 months ago
JSON representation

JavaScript API for sketchtool.

• Host: GitHub
• URL: https://github.com/vil-lang/sketchtool-api
• Owner: vil-lang
• License: mit
• Created: 2016-11-19T19:39:30.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-27T13:47:43.000Z (almost 8 years ago)
• Last Synced: 2024-07-27T01:21:19.895Z (about 2 months ago)
• Topics: api, sketch-app, sketchtool
• Language: JavaScript
• Size: 2.26 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# sketchtool-api

> JavaScript API for sketchtool.

[![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url]

[travis-image]: https://img.shields.io/travis/ngryman/sketchtool-api.svg?style=flat

[travis-url]: https://travis-ci.org/ngryman/sketchtool-api

[codecov-image]: https://img.shields.io/codecov/c/github/ngryman/sketchtool-api.svg

[codecov-url]: https://codecov.io/github/ngryman/sketchtool-api

**sketchtool-api** allows you to access [sketchtool] command-line tool via a simple JavaScript API.

This package does not bundle **sketchtool**, you need to have it installed on your machine. You can follow the instructions here: https://www.sketchapp.com/tool/.

*Notice: For now only the `dump` command is supported.*

[sketchtool]: http://bohemiancoding.com/sketch/tool/

## Install

```sh

npm install --save sketchtool-api

```

## Usage

```javascript

import sketchtool from 'sketchtool'

// Dump a document as JSON

const doc = await sketchtool.dump('my-awesome-design.sketch')

```

## License

MIT © [Nicolas Gryman](https://ngryman.sh)