Skip to content

z-nith/stratomorph-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


code style: prettier https://github.com/Jmeza081/stratomorph-cli/blob/master/LICENSE

Stratomorph is a Node.js CLI color quantifier.

Give an image 🌄 . Get a nicely formatted color palette. It's that simple! 🎨

Installation

[Instructions]

To verify the installation:

$ stratomorph -v

Should print out:

███████╗████████╗██████╗  █████╗ ████████╗ ██████╗ ███╗   ███╗ ██████╗ ██████╗ ██████╗ ██╗  ██╗
██╔════╝╚══██╔══╝██╔══██╗██╔══██╗╚══██╔══╝██╔═══██╗████╗ ████║██╔═══██╗██╔══██╗██╔══██╗██║  ██║
███████╗   ██║   ██████╔╝███████║   ██║   ██║   ██║██╔████╔██║██║   ██║██████╔╝██████╔╝███████║
╚════██║   ██║   ██╔══██╗██╔══██║   ██║   ██║   ██║██║╚██╔╝██║██║   ██║██╔══██╗██╔═══╝ ██╔══██║
███████║   ██║   ██║  ██║██║  ██║   ██║   ╚██████╔╝██║ ╚═╝ ██║╚██████╔╝██║  ██║██║     ██║  ██║
╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝   ╚═╝    ╚═════╝ ╚═╝     ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝     ╚═╝  ╚═╝

0.0.1

Features

  • Input an image file, get a color palette .html
  • Choose to order colors based on luminosity
  • Select the number of colors returned as a palette.
  • Tweak the returned colors' brightness and contrast
  • Choose color model returned by cli as rgb, hex, cmyk
  • Get the color palette returned as a .json object

Basic Usage

sample commands

Documentation

Link to github pages

Contributing

ATTN: NOT PUBLISHED YET

$ yarn install [packageName]
$ yarn link
$ stratomorph

About

Built with 💪🏽 & the following libraries

  • gluegun - Build your CLI in Node.js
  • canvas - A Node.JS port of Canvas to build the necessary imageData used by CLI.
  • rgbquant - Quantify colors found in an image by leveraging the Median Cut Algorithm
  • color - Manipulate colors using Javascript
  • validator - To sanitize and sanity-check user input