undraw-cli 0.4.0 β†’ 1.0.5

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.
Files changed (2) hide show
  1. package/README.md +17 -18
  2. package/package.json +9 -5
package/README.md CHANGED
@@ -4,16 +4,17 @@
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
5
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/stefdevscore/undraw-cli/blob/main/CONTRIBUTING.md)
6
6
 
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.
7
+ > A high-performance, ultra-minimalist CLI to search, customize, and download the entire [unDraw](https://undraw.co) library (1,650+ illustrations) for your next project.
8
8
 
9
9
  ---
10
10
 
11
11
  ## ✨ Features
12
12
 
13
- - **πŸš€ Instant Search**: Search 1,650+ illustrations by keyword from a local, optimized inventory.
13
+ - **🎯 Zero-Dependency Networking**: Built with native Node 20 `fetch`β€”no external network libraries.
14
+ - **πŸš€ Consolidated Search**: Search 1,650+ illustrations by keyword or browse by page using a single unified command.
14
15
  - **🎨 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
+ - **πŸ“¦ Ultra-Tiny footprint**: Only **40 kB** unpacked. Reached "4-file parity" with premium standards.
17
+ - **πŸ€– Agentic Ready**: Optimized for AI developers who need structured, fast access to high-quality SVG assets.
17
18
 
18
19
  ---
19
20
 
@@ -41,34 +42,35 @@ npm install -g undraw-cli
41
42
 
42
43
  ### Usage
43
44
 
44
- 1. **Sync the library** (updates your local inventory with the latest illustrations):
45
+ 1. **List or Search illustrations**:
45
46
  ```bash
46
- undraw sync
47
+ undraw list # Browse by page (20 per page)
48
+ undraw list "space" # Search for "space"
49
+ undraw list --page 2 # Go to page 2
47
50
  ```
48
51
 
49
- 2. **Search for an illustration**:
52
+ 2. **Download with a custom color**:
50
53
  ```bash
51
- undraw search "astronomy"
54
+ undraw download astronomy_ied1 --color #34d399
52
55
  ```
53
56
 
54
- 3. **Download with a custom color**:
57
+ 3. **Sync the library** (updates the embedded inventory):
55
58
  ```bash
56
- undraw download astronomy_ied1 --color #34d399
59
+ undraw sync
57
60
  ```
58
61
 
59
62
  ---
60
63
 
61
64
  ## πŸ› οΈ Commands
62
65
 
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 list [query]`: Paginated browsing or keyword search.
66
67
  - `undraw download <id>`: Fetch the SVG and apply a custom hex color.
68
+ - `undraw sync`: Crawls unDraw.co and updates the embedded source metadata.
67
69
 
68
70
  ---
69
71
 
70
72
  ## πŸ—ΊοΈ Roadmap
71
- Check out our [Roadmap](./docs/roadmap.md) for planned features like Interactive TUI, Full Mirroring, and ANSI Previews.
73
+ Check out our [Roadmap](./docs/roadmap.md) for planned features like Interactive TUI, Global Mirroring, and ANSI Previews.
72
74
 
73
75
  ---
74
76
 
@@ -78,10 +80,7 @@ Check out our [Roadmap](./docs/roadmap.md) for planned features like Interactive
78
80
  The illustrations are provided by the amazing **Katerina Limpitsouni** at [unDraw.co](https://undraw.co).
79
81
  If you love these illustrations, please visit their website and support their work!
80
82
 
81
- ### Tooling
82
- - **Commander.js** for the CLI engine.
83
- - **tsup** for high-speed ESM bundling.
84
- - **Chalk** & **Ora** for the terminal experience.
83
+ *Note: This is an unofficial community project and is not affiliated with unDraw.co.*
85
84
 
86
85
  ---
87
86
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "undraw-cli",
3
- "version": "0.4.0",
3
+ "version": "1.0.5",
4
4
  "description": "A CLI to search, customize, and download illustrations from undraw.co",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -31,14 +31,18 @@
31
31
  "agentic-ai"
32
32
  ],
33
33
  "author": "azk",
34
- "license": "MIT",
34
+ "license": "Unlicense",
35
35
  "repository": {
36
36
  "type": "git",
37
- "url": "git+https://github.com/stefdevscore/undraw-cli.git"
37
+ "url": "git+https://github.com/stefdevscore/undraw.git",
38
+ "directory": "wrapper-js"
38
39
  },
39
- "homepage": "https://github.com/stefdevscore/undraw-cli#readme",
40
+ "publishConfig": {
41
+ "access": "public"
42
+ },
43
+ "homepage": "https://github.com/stefdevscore/undraw#readme",
40
44
  "bugs": {
41
- "url": "https://github.com/stefdevscore/undraw-cli/issues"
45
+ "url": "https://github.com/stefdevscore/undraw/issues"
42
46
  },
43
47
  "dependencies": {
44
48
  "chalk": "^5.3.0",