@coolicons/cli 0.0.0 → 5.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kryston Schwarze
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,41 @@
 # @coolicons/cli
 
-Reserved for coolicons 5. Use version 5 or later, see [github.com/krystonschwarze/coolicons](https://github.com/krystonschwarze/coolicons).
+<a href="https://coolicons.cool"><img src="https://raw.githubusercontent.com/krystonschwarze/coolicons/main/.github/assets/banner.png" alt="coolicons: Every icon for your next project. Free, wherever you build." width="100%"></a>
+
+Search [coolicons](https://coolicons.cool) and copy them into your project from the terminal: 1,220 icons in five styles and three corner radii. No install, no dependencies, no network. The whole set ships inside the package.
+
+```sh
+npx @coolicons/cli search delete
+npx @coolicons/cli show trash --style fill > trash.svg
+npx @coolicons/cli add trash bell --style bulk --radius round --out src/icons
+```
+
+## Commands
+
+| Command | |
+| --- | --- |
+| `search <query>` | Find icons by name or meaning, ranked like the search on coolicons.cool |
+| `show <name>` | Print one icon's SVG to stdout |
+| `add <name...>` | Write SVG files into a folder |
+| `list` | Print every icon name |
+
+| Option | |
+| --- | --- |
+| `-s, --style` | `line`, `duocolor`, `duotone`, `fill` or `bulk`. Default `line` |
+| `-r, --radius` | `sharp`, `regular` or `round`. Default `regular` |
+| `-o, --out` | Folder for `add`. Default `./icons` |
+| `-l, --limit` | Results for `search`. Default 20 |
+| `-c, --category` | Only one category, for `list` |
+| `--size`, `--stroke` | Size and stroke width of the SVG. Default 24 and 2 |
+| `--json` | Machine readable output for `search` and `list` |
+
+`show` and `list` write only their result to stdout, everything else goes to stderr, so you can pipe them:
+
+```sh
+npx @coolicons/cli list | grep chart
+npx @coolicons/cli show mail --style fill | pbcopy
+```
+
+A name that does not exist suggests the closest ones: `show chekc` answers with `check`.
+
+More in the [coolicons repository](https://github.com/krystonschwarze/coolicons#readme). MIT license.

package/dist/cli.js

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { component, findIcon, iconSet, LookupError, RADII, search, STYLES, svg } from "./core.js";
+
+const { version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+
+const HELP = `coolicons ${version}
+
+Search coolicons and copy them into your project. No network, the whole set ships in this package.
+
+Usage
+  coolicons search <query>          Find icons by name or meaning, ranked
+  coolicons show <name>             Print one icon's SVG to stdout
+  coolicons add <name...>           Write SVG files into a folder
+  coolicons list                    Print every icon name
+
+Options
+  -s, --style <style>     ${STYLES.join(", ")} (default line)
+  -r, --radius <radius>   ${RADII.join(", ")} (default regular)
+  -o, --out <dir>         Folder for add (default ./icons)
+  -l, --limit <n>         Results for search (default 20)
+  -c, --category <name>   Only this category, for list
+      --size <px>         Width and height of the SVG (default 24)
+      --stroke <px>       Stroke width for line, duocolor and duotone (default 2)
+      --json              Machine readable output for search and list
+  -h, --help              Show this help
+  -v, --version           Show the version
+
+Examples
+  npx @coolicons/cli search delete
+  npx @coolicons/cli show trash --style fill > trash.svg
+  npx @coolicons/cli add trash bell --style bulk --radius round --out src/icons
+`;
+
+const SHORT = { s: "style", r: "radius", o: "out", l: "limit", c: "category", h: "help", v: "version" };
+const VALUED = new Set(["style", "radius", "out", "limit", "category", "size", "stroke"]);
+
+function parse(argv) {
+  const options = {};
+  const words = [];
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+    if (!arg.startsWith("-") || arg === "-") {
+      words.push(arg);
+      continue;
+    }
+    const [raw, inline] = arg.replace(/^--?/, "").split("=", 2);
+    const key = arg.startsWith("--") ? raw : (SHORT[raw] ?? raw);
+    if (VALUED.has(key)) {
+      const value = inline ?? argv[++i];
+      if (value === undefined) throw new LookupError(`--${key} needs a value.`);
+      options[key] = value;
+    } else options[key] = true;
+  }
+  return { command: words[0], words: words.slice(1), options };
+}
+
+const out = (text) => process.stdout.write(text.endsWith("\n") ? text : `${text}\n`);
+const say = (text) => process.stderr.write(`${text}\n`);
+
+function variant(options) {
+  return { style: options.style ?? "line", radius: options.radius ?? "regular", size: options.size ?? 24, strokeWidth: options.stroke ?? 2 };
+}
+
+function run({ command, words, options }) {
+  if (options.version) return out(version);
+  if (options.help || !command || command === "help") return out(HELP);
+
+  if (command === "search") {
+    const query = words.join(" ");
+    if (!query) throw new LookupError("search needs a query, like: coolicons search delete");
+    const results = search(query, Number(options.limit ?? 20));
+    if (options.json) return out(JSON.stringify(results.map((icon) => ({ ...icon, component: component(icon) })), null, 2));
+    if (!results.length) {
+      say(`No icon matches "${query}".`);
+      process.exitCode = 1;
+      return;
+    }
+    const width = Math.max(...results.map((icon) => icon.name.length));
+    for (const icon of results) out(`${icon.name.padEnd(width)}  ${component(icon)}  ${icon.category}${icon.keywords.length ? `  ${icon.keywords.join(", ")}` : ""}`);
+    say(`${results.length} of ${iconSet().icons.length} icons`);
+    return;
+  }
+
+  if (command === "show") {
+    if (words.length !== 1) throw new LookupError("show needs exactly one name, like: coolicons show trash");
+    return out(svg(words[0], variant(options)));
+  }
+
+  if (command === "add") {
+    if (!words.length) throw new LookupError("add needs at least one name, like: coolicons add trash bell");
+    const icons = words.map(findIcon);
+    const folder = path.resolve(options.out ?? "icons");
+    mkdirSync(folder, { recursive: true });
+    for (const icon of icons) {
+      const file = path.join(folder, `${icon.name}.svg`);
+      writeFileSync(file, svg(icon.name, variant(options)));
+      say(`Wrote ${path.relative(process.cwd(), file) || file}`);
+    }
+    return;
+  }
+
+  if (command === "list") {
+    const icons = options.category ? iconSet().icons.filter((icon) => icon.category.toLowerCase() === String(options.category).toLowerCase()) : iconSet().icons;
+    if (!icons.length) throw new LookupError(`No category "${options.category}". Categories: ${[...new Set(iconSet().icons.map((icon) => icon.category))].join(", ")}.`);
+    if (options.json) return out(JSON.stringify(icons.map((icon) => icon.name)));
+    out(icons.map((icon) => icon.name).join("\n"));
+    say(`${icons.length} icons`);
+    return;
+  }
+
+  throw new LookupError(`Unknown command "${command}". Run coolicons --help.`);
+}
+
+try {
+  run(parse(process.argv.slice(2)));
+} catch (error) {
+  if (!(error instanceof LookupError)) throw error;
+  say(error.message);
+  process.exitCode = 1;
+}

package/dist/core.js

@@ -0,0 +1,134 @@
+import { readFileSync } from "node:fs";
+import { matchIcons } from "./search.js";
+
+export const STYLES = ["line", "duocolor", "duotone", "fill", "bulk"];
+export const RADII = ["sharp", "regular", "round"];
+export const STROKED = new Set(["line", "duocolor", "duotone"]);
+export const SITE = "https://coolicons.cool";
+
+const read = (file) => JSON.parse(readFileSync(new URL(`./data/${file}`, import.meta.url), "utf8"));
+
+let set;
+const chunks = new Map();
+let byName;
+
+export function iconSet() {
+  set ??= read("index.json");
+  return set;
+}
+
+function lookup() {
+  byName ??= new Map(iconSet().icons.map((icon) => [icon.name, icon]));
+  return byName;
+}
+
+export class LookupError extends Error {
+  constructor(message, suggestions = []) {
+    super(message);
+    this.suggestions = suggestions;
+  }
+}
+
+export function toName(input) {
+  return String(input)
+    .trim()
+    .replace(/Icon$/, "")
+    .replace(/([a-z0-9])([A-Z])/g, "$1-$2")
+    .replace(/[\s_]+/g, "-")
+    .toLowerCase();
+}
+
+export function findIcon(input) {
+  const name = toName(input);
+  const icon = lookup().get(name);
+  if (icon) return icon;
+  const suggestions = suggest(name);
+  throw new LookupError(
+    `No coolicons icon is named "${name}".${suggestions.length ? ` Did you mean ${suggestions.join(", ")}?` : ""}`,
+    suggestions,
+  );
+}
+
+export function checkVariant(style = "line", radius = "regular") {
+  if (!STYLES.includes(style)) throw new LookupError(`Unknown style "${style}". Styles: ${STYLES.join(", ")}.`);
+  if (!RADII.includes(radius)) throw new LookupError(`Unknown radius "${radius}". Radii: ${RADII.join(", ")}.`);
+  return { style, radius };
+}
+
+export function search(query, limit = 10) {
+  return matchIcons(iconSet().icons, query).slice(0, limit);
+}
+
+function distance(a, b) {
+  const d = Array.from({ length: a.length + 1 }, (_, i) => Array.from({ length: b.length + 1 }, (_, j) => (i === 0 ? j : j === 0 ? i : 0)));
+  for (let i = 1; i <= a.length; i++) {
+    for (let j = 1; j <= b.length; j++) {
+      const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+      d[i][j] = Math.min(d[i - 1][j] + 1, d[i][j - 1] + 1, d[i - 1][j - 1] + cost);
+      if (i > 1 && j > 1 && a[i - 1] === b[j - 2] && a[i - 2] === b[j - 1]) d[i][j] = Math.min(d[i][j], d[i - 2][j - 2] + 1);
+    }
+  }
+  return d[a.length][b.length];
+}
+
+export function suggest(input, limit = 5) {
+  const name = toName(input);
+  if (!name) return [];
+  const found = search(name.replaceAll("-", " "), limit).map((icon) => icon.name);
+  if (found.length >= limit) return found;
+  const near = iconSet()
+    .icons.map((icon) => ({ name: icon.name, cost: distance(name, icon.name) }))
+    .filter((entry) => entry.cost <= Math.max(2, Math.floor(name.length / 3)) && !found.includes(entry.name))
+    .sort((a, b) => a.cost - b.cost || a.name.localeCompare(b.name))
+    .map((entry) => entry.name);
+  return [...found, ...near].slice(0, limit);
+}
+
+export function component(icon) {
+  const pascal = icon.name
+    .split("-")
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join("");
+  return Object.hasOwn(iconSet().clashes, icon.name) ? `${pascal}Icon` : pascal;
+}
+
+export function svg(input, { style = "line", radius = "regular", size = 24, strokeWidth = 2 } = {}) {
+  const icon = findIcon(input);
+  checkVariant(style, radius);
+  const key = `${style}-${radius}`;
+  if (!chunks.has(key)) chunks.set(key, read(`${key}.json`));
+  let inner = chunks.get(key)[icon.name];
+  if (STROKED.has(style) && Number(strokeWidth) !== 2) inner = inner.replaceAll('stroke-width="2"', `stroke-width="${strokeWidth}"`);
+  return `<svg width="${size}" height="${size}" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">${inner}</svg>\n`;
+}
+
+const entry = (style, radius) => (style === "line" && radius === "regular" ? "" : radius === "regular" ? `/${style}` : `/${style}/${radius}`);
+
+export function registryItem(icon, style = "line", radius = "regular") {
+  return [style === "line" && radius === "regular" ? "" : style, radius === "regular" ? "" : radius, icon.name].filter(Boolean).join("/");
+}
+
+export function usage(inputs, { framework = "react", style = "line", radius = "regular" } = {}) {
+  checkVariant(style, radius);
+  const icons = [inputs].flat().map(findIcon);
+  const names = icons.map(component);
+  if (framework === "react" || framework === "vue") {
+    const from = `@coolicons/${framework}${entry(style, radius)}`;
+    const imports = `import { ${names.join(", ")} } from "${from}";`;
+    const tags = names.map((name) => (framework === "react" ? `<${name} size={20} />` : `<${name} :size="20" />`)).join("\n");
+    const code = framework === "react" ? `${imports}\n\n${tags}` : `<script setup>\n${imports}\n</script>\n\n<template>\n${tags}\n</template>`;
+    return { install: `npm install @coolicons/${framework}`, code };
+  }
+  if (framework === "svg") {
+    return {
+      install: "npm install @coolicons/svg",
+      code: icons.map((icon) => `@coolicons/svg/${style}/${radius}/${icon.name}.svg`).join("\n"),
+    };
+  }
+  if (framework === "shadcn") {
+    const items = icons.map((icon) => `${SITE}/r/${registryItem(icon, style, radius)}.json`);
+    const files = icons.map((icon) => `components/icons/${registryItem(icon, style, radius)}.tsx`);
+    return { install: `npx shadcn@latest add ${items.join(" ")}`, code: `Adds ${files.join(", ")} exporting ${names.join(", ")}.` };
+  }
+  throw new LookupError(`Unknown framework "${framework}". Use react, vue, svg or shadcn.`);
+}