https://github.com/mwcz/colorpal-cli

A command-line version of ColorPal.
https://github.com/mwcz/colorpal-cli

Last synced: 2 months ago
JSON representation

A command-line version of ColorPal.

• Host: GitHub
• URL: https://github.com/mwcz/colorpal-cli
• Owner: mwcz
• License: gpl-2.0
• Created: 2013-11-09T17:06:59.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-12-29T18:14:51.000Z (over 11 years ago)
• Last Synced: 2025-03-17T17:09:27.818Z (2 months ago)
• Language: JavaScript
• Size: 6.84 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ColorPal CLI

============

ColorPal CLI is a command-line version of [ColorPal][4], my HTML5 color palette

generator.

### Demo!

    $ node cpal.js -f hex -s 8 MyImage.png

    #07070b

    #bac0c4

    #d1bd66

    #7e8899

    #696964

    #c4b441

    #65683e

    #394434

### Get it!

    npm install -g canvas requirejs # install dependencies

    git clone [email protected]:mwcz/colorpal-cli.git

    cd colorpal-cli

To display the help text, simply run the command without any arguments.

    node cpal.js

To start out, you can generate palettes from the sample images included with

the project.

    node cpal.js images/hugepic.png

    [ [ 144, 43, 178 ],

      [ 37, 10, 146 ],

      [ 171, 52, 6 ],

      [ 11, 3, 85 ],

      [ 238, 72, 120 ],

      [ 219, 66, 32 ] ]

To visualize what just happened, ColorPal turned this:

![hugepic.png](https://raw.github.com/mwcz/colorpal-cli/master/images/hugepic_small.png "hugepic.png")

Into this:

![hugepic.png colors](https://raw.github.com/mwcz/colorpal-cli/master/images/hugepic_colors.png "hugepic.png colors")

Let's try again with a different image.

    node cpal.js images/issue3.png

    [ [ 165, 219, 144 ], [ 58, 181, 75 ], [ 254, 250, 203 ] ]

Only three colors this time?

![issue3.png](https://raw.github.com/mwcz/colorpal-cli/master/images/issue3_small.png "issue3.png")

Ah, the image has very few colors, so ColorPal decided to create a smaller

palette.

![issue3.png colors](https://raw.github.com/mwcz/colorpal-cli/master/images/issue3_colors.png "issue3.png colors")

To generate a specific number of colors, use the `-s` option.

    # generate 8 colors from the same image

    node cpal.js -s 8 images/issue3.png

You can also specify the output format.  `json` is the default, but several others are available.

Hex:

    node cpal.js images/issue3.png -f hex

    #a5db90

    #3ab54b

    #fefacb

LESS:

    node cpal.js images/issue3.png -f less

    @color0: rgb(165,219,144);

    @color1: rgb(58,181,75);

    @color2: rgb(254,250,203);

SCSS/SASS:

    node cpal.js images/issue3.png -f scss

    $color0: rgb(165,219,144);

    $color1: rgb(58,181,75);

    $color2: rgb(254,250,203);

ColorPal also has a [web interface][4] which you might find more convenient,

depending on your needs  The command-line utility is very convenient if you

need to automate palette generation for a large number of images.

[4]: http://colorpal.org/ "colorpal.org"