undraw-cli 0.1.2 β 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -29
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,53 +1,89 @@
|
|
|
1
|
-
# unDraw CLI
|
|
1
|
+
# unDraw CLI π
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/undraw-cli)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
[](https://github.com/stefdevscore/undraw-cli/blob/main/CONTRIBUTING.md)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
> A high-performance, minimalist CLI to search, customize, and download the entire [unDraw](https://undraw.co) library (1,650+ illustrations) for your next project.
|
|
6
8
|
|
|
7
|
-
|
|
8
|
-
- π¨ **Customize**: Change the primary color (`#6c63ff`) to any hex code on-the-fly.
|
|
9
|
-
- π¦ **Download**: Save customized SVGs directly to your project.
|
|
9
|
+
---
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## β¨ Features
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
- **π Instant Search**: Search 1,650+ illustrations by keyword from a local, optimized inventory.
|
|
14
|
+
- **π¨ On-the-Fly Customization**: Automatically replace the default unDraw color with your brand's hex code.
|
|
15
|
+
- **π¦ Tiny Footprint**: Only **66 kB** unpacked. No bloat, just performance.
|
|
16
|
+
- **π€ Agentic Ready**: Built for AI developers who need structured access to high-quality SVG assets.
|
|
16
17
|
|
|
17
|
-
|
|
18
|
+
---
|
|
18
19
|
|
|
19
|
-
##
|
|
20
|
+
## π¨ Zero-Config Customization
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
One command to match your brand. No browser required.
|
|
22
23
|
|
|
23
|
-
|
|
24
|
+
| Original (`#6c63ff`) | Customized (`#ff0077`) |
|
|
25
|
+
| :--- | :--- |
|
|
26
|
+
|  |  |
|
|
24
27
|
|
|
25
28
|
```bash
|
|
26
|
-
undraw
|
|
29
|
+
undraw download astronomy_ied1 --color #ff0077
|
|
27
30
|
```
|
|
28
31
|
|
|
29
|
-
|
|
32
|
+
---
|
|
30
33
|
|
|
31
|
-
|
|
32
|
-
undraw list --page 1 --limit 20
|
|
33
|
-
```
|
|
34
|
+
## π Quick Start
|
|
34
35
|
|
|
35
|
-
###
|
|
36
|
+
### Installation
|
|
36
37
|
|
|
37
38
|
```bash
|
|
38
|
-
|
|
39
|
+
npm install -g undraw-cli
|
|
39
40
|
```
|
|
40
41
|
|
|
41
|
-
###
|
|
42
|
+
### Usage
|
|
42
43
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
1. **Sync the library** (updates your local inventory with the latest illustrations):
|
|
45
|
+
```bash
|
|
46
|
+
undraw sync
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
2. **Search for an illustration**:
|
|
50
|
+
```bash
|
|
51
|
+
undraw search "astronomy"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
3. **Download with a custom color**:
|
|
55
|
+
```bash
|
|
56
|
+
undraw download astronomy_ied1 --color #34d399
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## π οΈ Commands
|
|
62
|
+
|
|
63
|
+
- `undraw sync`: Crawls unDraw.co and builds a local metadata cache.
|
|
64
|
+
- `undraw list`: Browse the library with pagination (83+ pages).
|
|
65
|
+
- `undraw search <query>`: Search the inventory by title.
|
|
66
|
+
- `undraw download <id>`: Fetch the SVG and apply a custom hex color.
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## πΊοΈ Roadmap
|
|
71
|
+
Check out our [Roadmap](./docs/roadmap.md) for planned features like Interactive TUI, Full Mirroring, and ANSI Previews.
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## π Credits & Attribution
|
|
46
76
|
|
|
47
|
-
|
|
77
|
+
### unDraw Illustrations
|
|
78
|
+
The illustrations are provided by the amazing **Katerina Limpitsouni** at [unDraw.co](https://undraw.co).
|
|
79
|
+
If you love these illustrations, please visit their website and support their work!
|
|
48
80
|
|
|
49
|
-
|
|
81
|
+
### Tooling
|
|
82
|
+
- **Commander.js** for the CLI engine.
|
|
83
|
+
- **tsup** for high-speed ESM bundling.
|
|
84
|
+
- **Chalk** & **Ora** for the terminal experience.
|
|
50
85
|
|
|
51
|
-
|
|
86
|
+
---
|
|
52
87
|
|
|
53
|
-
|
|
88
|
+
## βοΈ License
|
|
89
|
+
MIT Β© [azk](https://github.com/stefdevscore)
|