usage-instructions.md

↤ Developer Overview

Usage Instructions

After installation, you can run the following in terminal:

color-library --options

NOTE: This will CLI tool will create a new libraries directory if it does not already exist. If it does, it will overwrite whatever is in that directory with new output. We do not include this libraries folder in the repo, as there are close to 50,000 files in that directory. You will, however, find a libraries.zip file in the root of this repository, which contains a packed version of that folder. You can safely unpack it locally as long as you do not rename the folder.

CLI Options

  -p, --pantone         Generate Pantone Color Library  [boolean] [default: false]
  -r, --ral             Generate RAL Color Library      [boolean] [default: false]
  -c, --collection      Filter Colors by Collection       [string] [default: null]
  -s, --set             Filter Colors by Set              [string] [default: null]
  -n, --name            Filter Colors by Name             [string] [default: null]
  -x, --code            Filter Colors by Code             [string] [default: null]
  -h, --hex             Filter Colors by HEX              [string] [default: null]
      --dry, --dry-run  Dry Run Only                    [boolean] [default: false]
      --help            Show help                                        [boolean]
      --version         Show version number                              [boolean]

Examples using CLI Params

Generate All Libraries ( if no params are passed over, all are used )

color-library

Generate RAL Library

color-library --ral

Generate Pantone Library

color-library --pantone

Generate Pantone Fashion Library

color-library -p -collection=fashion

Generate Pantone Fashion Cotton Library

color-library -p -c=fashion --set=cotton

Generate Library from Names Containing "blue"

color-library --name=blue

Generate Library from Codes Containing "tpx"

color-library --code=tpx

Generate Library from HEX Colors Starting with "abc"

color-library --hex=abc

Process Libraries but don't write to disk

color-library --dry-run