Skip to content

Latest commit

 

History

History
127 lines (107 loc) · 5.44 KB

CLI.md

File metadata and controls

127 lines (107 loc) · 5.44 KB

🕹️ Command Line Api

🚸 Usage Documentation

#️⃣ cono usage

cono <command>

Commands:
  cono palette <name> [--blindness]         Generate Harmonic Color Palettes
  [--json] [--greedy]                       from Cono Color(s).
  cono nearest <hex> [--colorspace]         Get the Closest Cono Color Name for
  [--blindness]                             the given Hex Color.
  cono color <name> [--colorspace]          Retrieve color information for given
  [--blindness]                             a Cono Color Name.
  cono run <generator> [--language]         Run generators builtin with Cono.

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

Made with ❤️ by Arvind Srinivasan.
Licensed under Apache-2.0.

#️⃣ cono color usage

cono color <name> [--colorspace] [--blindness]

Retrieve color information for given a Cono Color Name.

Positionals:
  n, name               Color Name following Cono's naming conventions. [string]
  c, space, colorspace  Name of the CSS Colorspace to convert to.
  [string] [choices: "all", "hex", "rgb", "hsl", "hwb", "cymk"] [default: "all"]
  b, blind, blindness   Name of the Blindness Type you want to emulate.
                [string] [choices: "protanomaly", "protanopia", "deuteranomaly",
  "deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

#️⃣ cono nearest usage

cono nearest <hex> [--colorspace] [--blindness]

Get the Closest Cono Color Name for the given Hex Color.

Positionals:
  x, hex                6-Digit Hash Prefixed Hex Color to Find Nearest for.
                                                                        [string]
  c, space, colorspace  Name of the CSS Colorspace to convert to.
  [string] [choices: "all", "hex", "rgb", "hsl", "hwb", "cymk"] [default: "all"]
  b, blind, blindness   Name of the Blindness Type you want to emulate.
                [string] [choices: "protanomaly", "protanopia", "deuteranomaly",
  "deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

#️⃣ cono run usage

cono run <generator> [--language]

Run generators builtin with Cono.

Positionals:
  g, gen, generator  Name the Generator you choose to run.
                                             [string] [choices: "color", "scss"]
  l, lang, language  Enter 2-letter ISO 639-1 Code for the Language you wish to
                     use for naming.
                                  [string] [choices: "en", "ta"] [default: "en"]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

#️⃣ cono palette usage

cono palette <name> [--blindness] [--json] [--greedy]

Generate Harmonic Color Palettes from Cono Color(s).

Positionals:
  n, name              Color Name following Cono's naming conventions.  [string]
  b, blind, blindness  Name of the Blindness Type you want to emulate.
                [string] [choices: "protanomaly", "protanopia", "deuteranomaly",
  "deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]
  j, json              When set, returns json instead of visual representation.
                                                      [boolean] [default: false]
  g, greedy            When set, matches all colors containing the string.
                                                      [boolean] [default: false]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

ℹ️ Usage Examples

#️⃣ For cono color

cname cnamespace cnamespaceblind

#️⃣ For cono nearest

nname nnamespace nnamespaceblind

#️⃣ For cono palette

p1 p2 pj pgj