nekos 2.0.3 → 3.1.0

package/README.md

@@ -36,9 +36,48 @@ nekos({ colors: "RANDOM" });
 
 // Log a cat with a custom gradient
 nekos({ colors: ["#ff00ff", "#00ffff"] });
+
+// Log a specific cat with two random gradient colors
+nekos({ id: "sad_cat", colors: ["RANDOM", "RANDOM"] });
+```
+
+[ESM Example - demo.js](test/demo.js)  
+[CJS Example - demo.cjs](test/demo.cjs)
+
+---
+
+## CLI Usage
+
+For command line use, either install the package globally or use `npx`.
+
+```bash
+# Install globally
+npm install -g nekos
 ```
 
-[Example - demo.js](test/demo.js)
+### Examples
+
+```bash
+# Display a random cat
+nekos
+
+# Display a specific cat by ID
+nekos --id my_cat
+
+# Display a cat with a rainbow gradient
+nekos --colors RAINBOW
+
+# Display a cat with two random gradient colors
+nekos --colors RANDOM RANDOM
+
+# Display a specific cat with a custom gradient
+nekos --id sad_cat --colors "#ff00ff" "#00ffff"
+
+# You can also use npx without a global installation
+npx nekos --colors "#ff00ff #00ffff"
+```
+
+---
 
 ## API
 
@@ -103,9 +142,48 @@ nekos({ colors: "RANDOM" });
 
 // カスタムグラデーションで猫を表示
 nekos({ colors: ["#ff00ff", "#00ffff"] });
+
+// IDを指定した猫に、2色のランダムなグラデーションを適用
+nekos({ id: "sad_cat", colors: ["RANDOM", "RANDOM"] });
+```
+
+[ESM Example - demo.js](test/demo.js)  
+[CJS Example - demo.cjs](test/demo.cjs)
+
+---
+
+## コマンドラインでの使い方
+
+コマンドラインで使うには、パッケージをグローバルインストールするか、`npx`を利用します。
+
+```bash
+# グローバルインストール
+npm install -g nekos
 ```
 
-[Example - demo.js](test/demo.js)
+### 実行例
+
+```bash
+# ランダムな猫を表示
+nekos
+
+# IDを指定して特定の猫を表示
+nekos --id my_cat
+
+# 虹色のグラデーションで猫を表示
+nekos --colors RAINBOW
+
+# 2色のランダムなグラデーションで猫を表示
+nekos --colors RANDOM RANDOM
+
+# IDを指定した猫にカスタムグラデーションを適用
+nekos --id sad_cat --colors "#ff00ff" "#00ffff"
+
+# グローバルインストールなしでnpxを使っても実行できます
+npx nekos --colors "#ff00ff #00ffff"
+```
+
+---
 
 ## API
 

package/bin/nekos.js

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+import { program } from "commander";
+import nekos from "../dist/index.js";
+
+program
+  .option(
+    "-i, --id <id>",
+    "Display a specific cat by its ID (filename without .txt)"
+  )
+  .option(
+    "-c, --colors [colors...]",
+    'Specify colors (e.g., RANDOM, RAINBOW, #ff00ff, "#ff0000 #00ff00")'
+  );
+
+program.parse(process.argv);
+
+const options = program.opts();
+const nekosOptions = {};
+
+if (options.id) {
+  nekosOptions.id = options.id;
+}
+
+if (options.colors) {
+  const finalColors = options.colors.flatMap((colorString) =>
+    colorString.split(" ")
+  );
+
+  if (finalColors.length === 1) {
+    nekosOptions.colors = finalColors[0];
+  } else {
+    nekosOptions.colors = finalColors;
+  }
+}
+
+nekos(nekosOptions);

package/dist/index.cjs

@@ -34,6 +34,7 @@ __export(cjs_entry_exports, {
 module.exports = __toCommonJS(cjs_entry_exports);
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
+var import_consola = require("consola");
 var import_color = require("@randplus/color");
 var import_gradient_string = __toESM(require("gradient-string"));
 var aaDir = import_path.default.join(__dirname, "../aa");
@@ -80,8 +81,11 @@ function nekos(options = {}) {
         processedColors = [colors];
       }
     } else if (Array.isArray(colors)) {
+      if (colors.includes("RAINBOW")) {
+        import_consola.consola.warn("Cannot use the value, 'RAINBOW' in array.");
+      }
       processedColors = colors.map(
-        (color) => typeof color === "string" && color.toUpperCase() === "RANDOM" ? (0, import_color.hex)("#") : color
+        (color2) => typeof color2 === "string" && color2.toUpperCase() === "RANDOM" ? (0, import_color.hex)("#") : color2
       );
     } else {
       processedColors = colors;

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-type ColorKeyword = "RANDOM" | "RAINBOW";
+type SingleColorKeyword = "RAINBOW";
+type ColorKeyword = "RANDOM";
 type HexColor = `#${string}`;
 type ColorValue = ColorKeyword | HexColor;
 interface NekosOptions {
     id?: string;
-    colors?: ColorValue | ColorValue[];
+    colors?: SingleColorKeyword | ColorValue | ColorValue[];
 }
 /**
  * Logs a cat ASCII art to the console.

package/dist/index.js

@@ -2,6 +2,7 @@
 import fs from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
+import { consola } from "consola";
 import { hex } from "@randplus/color";
 import gradient from "gradient-string";
 var __filename = fileURLToPath(import.meta.url);
@@ -50,8 +51,11 @@ function nekos(options = {}) {
         processedColors = [colors];
       }
     } else if (Array.isArray(colors)) {
+      if (colors.includes("RAINBOW")) {
+        consola.warn("Cannot use the value, 'RAINBOW' in array.");
+      }
       processedColors = colors.map(
-        (color) => typeof color === "string" && color.toUpperCase() === "RANDOM" ? hex("#") : color
+        (color2) => typeof color2 === "string" && color2.toUpperCase() === "RANDOM" ? hex("#") : color2
       );
     } else {
       processedColors = colors;

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "nekos",
-  "version": "2.0.3",
+  "version": "3.1.0",
   "description": "Let's have cute cats mess around in the log!",
+  "bin": {
+    "nekos": "bin/nekos.js"
+  },
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -38,6 +41,8 @@
   "homepage": "https://github.com/otoneko1102/nekos#readme",
   "dependencies": {
     "@randplus/color": "^3.0.0",
+    "commander": "^14.0.0",
+    "consola": "^3.4.2",
     "gradient-string": "^3.0.0"
   },
   "devDependencies": {