undraw-cli 0.1.1 → 0.2.0

package/README.md

@@ -1,53 +1,89 @@
-# unDraw CLI
+# unDraw CLI 🎭
 
-A powerful CLI to search, customize, and download illustrations from [unDraw](https://undraw.co).
+[![npm version](https://img.shields.io/npm/v/undraw-cli.svg)](https://www.npmjs.com/package/undraw-cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/stefdevscore/undraw-cli/blob/main/CONTRIBUTING.md)
 
-## Features
+> A high-performance, minimalist CLI to search, customize, and download the entire [unDraw](https://undraw.co) library (1,650+ illustrations) for your next project.
 
-- 🔍 **Search**: Find illustrations by keyword.
-- 🎨 **Customize**: Change the primary color (`#6c63ff`) to any hex code on-the-fly.
-- 📦 **Download**: Save customized SVGs directly to your project.
+---
 
-## Installation
+## ✨ Features
 
-```bash
-npm install -g undraw-cli
-```
+- **🚀 Instant Search**: Search 1,650+ illustrations by keyword from a local, optimized inventory.
+- **🎨 On-the-Fly Customization**: Automatically replace the default unDraw color with your brand's hex code.
+- **📦 Tiny Footprint**: Only **66 kB** unpacked. No bloat, just performance.
+- **🤖 Agentic Ready**: Built for AI developers who need structured access to high-quality SVG assets.
 
-_(Note: Use `npx undraw-cli` if you don't want to install globally)_
+---
 
-## Usage
+## 🎨 Zero-Config Customization
 
-### Sync the full library
+One command to match your brand. No browser required.
 
-Run this first to build your local inventory (1,600+ items).
+| Original (`#6c63ff`) | Customized (`#ff0077`) |
+| :--- | :--- |
+| ![Original](./docs/assets/astronomy_original.svg) | ![Customized](./docs/assets/astronomy_pink.svg) |
 
 ```bash
-undraw sync
+undraw download astronomy_ied1 --color #ff0077
 ```
 
-### List illustrations
+---
 
-```bash
-undraw list --page 1 --limit 20
-```
+## 🚀 Quick Start
 
-### Search for illustrations
+### Installation
 
 ```bash
-undraw search astronomy
+npm install -g undraw-cli
 ```
 
-### Download and Customize
+### Usage
 
-```bash
-undraw download astronomy_ied1 --color #32a852 --output ./assets
-```
+1. **Sync the library** (updates your local inventory with the latest illustrations):
+   ```bash
+   undraw sync
+   ```
+
+2. **Search for an illustration**:
+   ```bash
+   undraw search "astronomy"
+   ```
+
+3. **Download with a custom color**:
+   ```bash
+   undraw download astronomy_ied1 --color #34d399
+   ```
+
+---
+
+## 🛠️ Commands
+
+- `undraw sync`: Crawls unDraw.co and builds a local metadata cache.
+- `undraw list`: Browse the library with pagination (83+ pages).
+- `undraw search <query>`: Search the inventory by title.
+- `undraw download <id>`: Fetch the SVG and apply a custom hex color.
+
+---
+
+## 🗺️ Roadmap
+Check out our [Roadmap](./docs/roadmap.md) for planned features like Interactive TUI, Full Mirroring, and ANSI Previews.
+
+---
+
+## 🙏 Credits & Attribution
 
-## How it works
+### unDraw Illustrations
+The illustrations are provided by the amazing **Katerina Limpitsouni** at [unDraw.co](https://undraw.co).  
+If you love these illustrations, please visit their website and support their work!
 
-The CLI fetches the latest illustration metadata from unDraw and performs a high-performance string replacement on the SVG source code to apply your custom primary color.
+### Tooling
+- **Commander.js** for the CLI engine.
+- **tsup** for high-speed ESM bundling.
+- **Chalk** & **Ora** for the terminal experience.
 
-## License
+---
 
-MIT
+## ⚖️ License
+MIT © [azk](https://github.com/stefdevscore)

package/dist/index.js

@@ -1,127 +1,4 @@
 #!/usr/bin/env node
-
-// src/index.ts
-import { Command } from "commander";
-import fetch from "node-fetch";
-import fs from "fs/promises";
-import path from "path";
-import chalk from "chalk";
-import ora from "ora";
-var program = new Command();
-var DEFAULT_COLOR = "#6c63ff";
-var BASE_URL = "https://undraw.co";
-var CDN_URL = "https://cdn.undraw.co/illustration";
-var INVENTORY_PATH = path.resolve(process.cwd(), "undraw-inventory.json");
-async function getBuildId() {
-  const response = await fetch(BASE_URL);
-  const html = await response.text();
-  const match = html.match(/"buildId":"([^"]+)"/);
-  return match ? match[1] : null;
-}
-async function fetchIllustrationsPage(buildId, page) {
-  const url = page === 1 ? `${BASE_URL}/_next/data/${buildId}/illustrations.json` : `${BASE_URL}/_next/data/${buildId}/illustrations/${page}.json?page=${page}`;
-  const response = await fetch(url);
-  if (!response.ok) return null;
-  const data = await response.json();
-  return data.pageProps.illustrations;
-}
-async function loadInventory() {
-  try {
-    const data = await fs.readFile(INVENTORY_PATH, "utf-8");
-    return JSON.parse(data);
-  } catch (_err) {
-    return null;
-  }
-}
-function printIllustrations(illustrations, title) {
-  if (illustrations.length === 0) {
-    console.log(chalk.red("No illustrations found."));
-    return;
-  }
-  console.log(chalk.green(`
-${title} (${illustrations.length}):`));
-  console.log(chalk.gray("\u2500".repeat(50)));
-  illustrations.forEach((i) => {
-    console.log(
-      `${chalk.bold((i.title || "Untitled").padEnd(30))} id: ${chalk.cyan(i.newSlug || i.slug)}`
-    );
-  });
-  console.log(chalk.gray("\u2500".repeat(50)) + "\n");
-}
-program.name("undraw").description("CLI to search and customize unDraw illustrations").version("0.1.0");
-program.command("sync").description("Sync the full unDraw library to a local inventory file").action(async () => {
-  const spinner = ora("Initializing sync...").start();
-  try {
-    const buildId = await getBuildId();
-    if (!buildId) throw new Error("Could not find buildId");
-    let allIllustrations = [];
-    let page = 1;
-    let hasMore = true;
-    while (hasMore) {
-      spinner.text = `Fetching page ${page}... (Total: ${allIllustrations.length})`;
-      const illustrations = await fetchIllustrationsPage(buildId, page);
-      if (!illustrations || illustrations.length === 0) {
-        hasMore = false;
-      } else {
-        allIllustrations = [...allIllustrations, ...illustrations];
-        page++;
-      }
-    }
-    spinner.text = "Saving inventory...";
-    await fs.writeFile(INVENTORY_PATH, JSON.stringify(allIllustrations, null, 2));
-    spinner.succeed(
-      chalk.green(`Synced ${allIllustrations.length} illustrations to ${INVENTORY_PATH}`)
-    );
-  } catch (_err) {
-    spinner.fail(chalk.red(`Sync failed: ${_err.message}`));
-  }
-});
-program.command("search").description("Search for illustrations by title").argument("<query>", "search query").action(async (query) => {
-  const illustrations = await loadInventory();
-  if (!illustrations) {
-    console.log(chalk.yellow('Inventory not found. Please run "undraw sync" first.'));
-    return;
-  }
-  const filtered = illustrations.filter(
-    (i) => (i.title || "").toLowerCase().includes(query.toLowerCase())
-  );
-  printIllustrations(filtered, `Found ${filtered.length} matches for "${query}"`);
-});
-program.command("list").description("List illustrations from local inventory").option("-p, --page <number>", "page number", "1").option("-l, --limit <number>", "items per page", "20").action(async (options) => {
-  const illustrations = await loadInventory();
-  if (!illustrations) {
-    console.log(chalk.yellow('Inventory not found. Please run "undraw sync" first.'));
-    return;
-  }
-  const page = parseInt(options.page, 10);
-  const limit = parseInt(options.limit, 10);
-  const start = (page - 1) * limit;
-  const end = start + limit;
-  const paginated = illustrations.slice(start, end);
-  const totalPages = Math.ceil(illustrations.length / limit);
-  printIllustrations(paginated, `Inventory: Page ${page} of ${totalPages}`);
-  if (page < totalPages) {
-    console.log(chalk.gray(`Run 'undraw list --page ${page + 1}' for more...`));
-  }
-});
-program.command("download").description("Download an illustration with a custom color").argument("<id>", "illustration id (e.g., astronomy_ied1)").option("-c, --color <hex>", "primary hex color", DEFAULT_COLOR).option("-o, --output <path>", "output file path", ".").action(async (id, options) => {
-  const spinner = ora(`Downloading ${id}...`).start();
-  try {
-    const url = `${CDN_URL}/${id}.svg`;
-    const response = await fetch(url);
-    if (!response.ok) throw new Error(`Illustration not found: ${id}`);
-    let svg = await response.text();
-    if (options.color !== DEFAULT_COLOR) {
-      spinner.text = `Applying color ${options.color}...`;
-      svg = svg.split(DEFAULT_COLOR).join(options.color);
-    }
-    const filename = `${id}.svg`;
-    const outputPath = path.resolve(options.output, filename);
-    await fs.writeFile(outputPath, svg);
-    spinner.succeed(chalk.green(`Saved to ${outputPath}`));
-  } catch (err) {
-    spinner.fail(chalk.red(`Error: ${err.message}`));
-  }
-});
-program.parse();
-//# sourceMappingURL=index.js.map
+import{Command as $}from"commander";import p from"node-fetch";import f from"fs/promises";import m from"path";import r from"chalk";import y from"ora";var l=new $,u="#6c63ff",d="https://undraw.co",v="https://cdn.undraw.co/illustration",g=m.resolve(process.cwd(),"undraw-inventory.json");async function I(){let n=(await(await p(d)).text()).match(/"buildId":"([^"]+)"/);return n?n[1]:null}async function b(t,o){let n=o===1?`${d}/_next/data/${t}/illustrations.json`:`${d}/_next/data/${t}/illustrations/${o}.json?page=${o}`,e=await p(n);return e.ok?(await e.json()).pageProps.illustrations:null}async function h(){try{let t=await f.readFile(g,"utf-8");return JSON.parse(t)}catch{return null}}function w(t,o){if(t.length===0){console.log(r.red("No illustrations found."));return}console.log(r.green(`
+${o} (${t.length}):`)),console.log(r.gray("\u2500".repeat(50))),t.forEach(n=>{console.log(`${r.bold((n[1]||"Untitled").padEnd(30))} id: ${r.cyan(n[0])}`)}),console.log(r.gray("\u2500".repeat(50))+`
+`)}l.name("undraw").description("CLI to search and customize unDraw illustrations").version("0.1.1");l.command("sync").description("Sync the full unDraw library to a local inventory file").action(async()=>{let t=y("Initializing sync...").start();try{let o=await I();if(!o)throw new Error("Could not find buildId");let n=[],e=1,a=!0;for(;a;){t.text=`Fetching page ${e}... (Items: ${n.length})`;let s=await b(o,e);!s||s.length===0?a=!1:(s.forEach(i=>{n.push([i.newSlug,i.title])}),e++)}t.text="Saving inventory...",await f.writeFile(g,JSON.stringify(n)),t.succeed(r.green(`Synced ${n.length} illustrations to ${g}`))}catch(o){t.fail(r.red(`Sync failed: ${o.message}`))}});l.command("search").description("Search for illustrations by title").argument("<query>","search query").action(async t=>{let o=await h();if(!o){console.log(r.yellow('Inventory not found. Please run "undraw sync" first.'));return}let n=o.filter(e=>(e[1]||"").toLowerCase().includes(t.toLowerCase()));w(n,`Found ${n.length} matches for "${t}"`)});l.command("list").description("List illustrations from local inventory").option("-p, --page <number>","page number","1").option("-l, --limit <number>","items per page","20").action(async t=>{let o=await h();if(!o){console.log(r.yellow('Inventory not found. Please run "undraw sync" first.'));return}let n=parseInt(t.page,10),e=parseInt(t.limit,10),a=(n-1)*e,s=a+e,i=o.slice(a,s),c=Math.ceil(o.length/e);w(i,`Inventory: Page ${n} of ${c}`),n<c&&console.log(r.gray(`Run 'undraw list --page ${n+1}' for more...`))});l.command("download").description("Download an illustration with a custom color").argument("<id>","illustration id (e.g., astronomy_ied1)").option("-c, --color <hex>","primary hex color",u).option("-o, --output <path>","output file path",".").action(async(t,o)=>{let n=y(`Downloading ${t}...`).start();try{let e=`${v}/${t}.svg`,a=await p(e);if(!a.ok)throw new Error(`Illustration not found: ${t}`);let s=await a.text();o.color!==u&&(n.text=`Applying color ${o.color}...`,s=s.split(u).join(o.color));let i=`${t}.svg`,c=m.resolve(o.output,i);await f.writeFile(c,s),n.succeed(r.green(`Saved to ${c}`))}catch(e){n.fail(r.red(`Error: ${e.message}`))}});l.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "undraw-cli",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A CLI to search, customize, and download illustrations from undraw.co",
   "type": "module",
   "main": "./dist/index.js",