https://github.com/d3dc/prickly

A Sketch.app plugin that prepares and updates your .sketch files for version control using Kactus-cli. Made for the command-line jockey.
https://github.com/d3dc/prickly

design git kactus sketchapp workflow

Last synced: about 1 month ago
JSON representation

A Sketch.app plugin that prepares and updates your .sketch files for version control using Kactus-cli. Made for the command-line jockey.

• Host: GitHub
• URL: https://github.com/d3dc/prickly
• Owner: d3dc
• Created: 2018-05-31T21:33:00.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-02T04:08:00.000Z (about 8 years ago)
• Last Synced: 2025-02-23T01:46:00.610Z (over 1 year ago)
• Topics: design, git, kactus, sketchapp, workflow
• Language: JavaScript
• Homepage:
• Size: 129 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md

Awesome Lists containing this project

README

          
# Prickly Sketch Plugin

This is a Sketch plugin to add menu items for `kactus-cli` - letting you use it as part of your existing workflow without an additional app.

![Example Screenshot](/docs/example.png)

## Requirements

* Sketch 44+

* kactus-cli (am I allowed to bundle this?)

  `npm install -g kactus-cli`

Kactus itself is not required

## Installation

* [Download a release](https://github.com/d3dc/Prickly/releases)

* Unzip

* Double click `Prickly.sketchplugin`

## Usage

* Design

* Select "Prickly > Commit Changes"

* ...

* Profit!

## Future

* File watching

* Git hooks?

## Difference from the Git plugin

The git plugin provides a lot of the features that Kactus does dynamically - statically. But it does it by brute-force rendering every symbol every commit. This plugin instead only unzips the sketch file and makes sketch's json format git-friendly.

## About this project

There are a few attempts to use Kactus CLI or bash to get a good git workflow going; But all of them are based on githooks and file watchers. Why run another Node process when Sketch can watch our files for us?

## Acknowledgements

[Kactus CLI](https://github.com/kactus-io/kactus-cli)