Skip to content

Commit a189bb4

Browse files
committed
Update CLI.md
1 parent 5790dd9 commit a189bb4

File tree

1 file changed

+127
-0
lines changed

1 file changed

+127
-0
lines changed

docs/CLI.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# 🕹️ Command Line Api
2+
3+
- [🕹️ **Command Line Api**](#-command-line-api)
4+
- [🚸 **Usage Documentation**](#-usage-documentation)
5+
- [#️⃣ cono usage](#%EF%B8%8F%E2%83%A3-cono-usage)
6+
- [#️⃣ cono color usage](#%EF%B8%8F%E2%83%A3-cono-color-usage)
7+
- [#️⃣ cono nearest usage](#%EF%B8%8F%E2%83%A3-cono-nearest-usage)
8+
- [#️⃣ cono run usage](#%EF%B8%8F%E2%83%A3-cono-run-usage)
9+
- [#️⃣ cono palette usage](#%EF%B8%8F%E2%83%A3-cono-palette-usage)
10+
- [ℹ️ **Usage Examples**](#-usage-examples)
11+
- [#️⃣ For cono color](#%EF%B8%8F%E2%83%A3-for-cono-color)
12+
- [#️⃣ For cono nearest](#%EF%B8%8F%E2%83%A3-for-cono-nearest)
13+
- [#️⃣ For cono palette](#%EF%B8%8F%E2%83%A3-for-cono-palette)
14+
15+
<!-- /TOC -->
16+
17+
## 🚸 Usage Documentation
18+
### #️⃣ `cono` usage
19+
```shell
20+
cono <command>
21+
22+
Commands:
23+
cono palette <name> [--blindness] Generate Harmonic Color Palettes
24+
[--json] [--greedy] from Cono Color(s).
25+
cono nearest <hex> [--colorspace] Get the Closest Cono Color Name for
26+
[--blindness] the given Hex Color.
27+
cono color <name> [--colorspace] Retrieve color information for given
28+
[--blindness] a Cono Color Name.
29+
cono run <generator> [--language] Run generators builtin with Cono.
30+
31+
Options:
32+
-h, --help Show help [boolean]
33+
-v, --version Show version number [boolean]
34+
35+
Made with ❤️ by Arvind Srinivasan.
36+
Licensed under Apache-2.0.
37+
```
38+
### #️⃣ `cono color` usage
39+
```shell
40+
cono color <name> [--colorspace] [--blindness]
41+
42+
Retrieve color information for given a Cono Color Name.
43+
44+
Positionals:
45+
n, name Color Name following Cono's naming conventions. [string]
46+
c, space, colorspace Name of the CSS Colorspace to convert to.
47+
[string] [choices: "all", "hex", "rgb", "hsl", "hwb", "cymk"] [default: "all"]
48+
b, blind, blindness Name of the Blindness Type you want to emulate.
49+
[string] [choices: "protanomaly", "protanopia", "deuteranomaly",
50+
"deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]
51+
52+
Options:
53+
-h, --help Show help [boolean]
54+
-v, --version Show version number [boolean]
55+
```
56+
### #️⃣ `cono nearest` usage
57+
```shell
58+
cono nearest <hex> [--colorspace] [--blindness]
59+
60+
Get the Closest Cono Color Name for the given Hex Color.
61+
62+
Positionals:
63+
x, hex 6-Digit Hash Prefixed Hex Color to Find Nearest for.
64+
[string]
65+
c, space, colorspace Name of the CSS Colorspace to convert to.
66+
[string] [choices: "all", "hex", "rgb", "hsl", "hwb", "cymk"] [default: "all"]
67+
b, blind, blindness Name of the Blindness Type you want to emulate.
68+
[string] [choices: "protanomaly", "protanopia", "deuteranomaly",
69+
"deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]
70+
71+
Options:
72+
-h, --help Show help [boolean]
73+
-v, --version Show version number [boolean]
74+
```
75+
### #️⃣ `cono run` usage
76+
```shell
77+
cono run <generator> [--language]
78+
79+
Run generators builtin with Cono.
80+
81+
Positionals:
82+
g, gen, generator Name the Generator you choose to run.
83+
[string] [choices: "color", "scss"]
84+
l, lang, language Enter 2-letter ISO 639-1 Code for the Language you wish to
85+
use for naming.
86+
[string] [choices: "en", "ta"] [default: "en"]
87+
88+
Options:
89+
-h, --help Show help [boolean]
90+
-v, --version Show version number [boolean]
91+
```
92+
### #️⃣ `cono palette` usage
93+
```shell
94+
cono palette <name> [--blindness] [--json] [--greedy]
95+
96+
Generate Harmonic Color Palettes from Cono Color(s).
97+
98+
Positionals:
99+
n, name Color Name following Cono's naming conventions. [string]
100+
b, blind, blindness Name of the Blindness Type you want to emulate.
101+
[string] [choices: "protanomaly", "protanopia", "deuteranomaly",
102+
"deuteranopia", "tritanomaly", "tritanopia", "achromatomaly", "achromatopsia"]
103+
j, json When set, returns json instead of visual representation.
104+
[boolean] [default: false]
105+
g, greedy When set, matches all colors containing the string.
106+
[boolean] [default: false]
107+
108+
Options:
109+
-h, --help Show help [boolean]
110+
-v, --version Show version number [boolean]
111+
```
112+
## ℹ️ Usage Examples
113+
### #️⃣ For `cono color`
114+
![cname](../screenshots/color-name.png)
115+
![cnamespace](../screenshots/color-name-space.png)
116+
![cnamespaceblind](../screenshots/color-name-space-blind.png)
117+
118+
### #️⃣ For `cono nearest`
119+
![nname](../screenshots/nearest-hex.png)
120+
![nnamespace](../screenshots/nearest-hex-space.png)
121+
![nnamespaceblind](../screenshots/nearest-hex-space-blind.png)
122+
### #️⃣ For `cono palette`
123+
124+
![p1](../screenshots/palette-str-primary.png)
125+
![p2](../screenshots/palette-str-secondary.png)
126+
![pj](../screenshots/palette-str-json.png)
127+
![pgj](../screenshots/palette-str-json-greedy.png)

0 commit comments

Comments
 (0)