@headband/cli 0.1.0

package/README.md

@@ -0,0 +1,69 @@
+# @headband/cli
+
+Interactive CLI for setting up [Headband](https://headband.dev) search in any project.
+
+## Usage
+
+```bash
+npx @headband/cli init
+```
+
+This will:
+
+1. Ask for your Headband URL (default: `https://headband.dev`)
+2. Ask for your search API key (`hb_src_...` or `hb_adm_...`)
+3. Ask for your default search index (e.g. `products`, `movies`)
+4. Detect your package manager (npm, pnpm, yarn, or bun)
+5. Install `@headband/react`
+6. Create `headband.config.ts` with your settings
+7. Create an example `<HeadbandSearch />` component
+
+## Options
+
+```bash
+npx @headband/cli init --yes   # Skip prompts, use defaults
+npx @headband/cli --help       # Show help
+```
+
+## What gets created
+
+**`headband.config.ts`** -- Search configuration that reads from `NEXT_PUBLIC_HEADBAND_KEY` env var with a fallback:
+
+```typescript
+export const headbandConfig = {
+  url: "https://headband.dev",
+  searchKey: process.env.NEXT_PUBLIC_HEADBAND_KEY || "hb_src_...",
+  defaultIndex: "products",
+};
+```
+
+**`components/headband-search.tsx`** (or `src/components/` if your project uses a `src/` directory) -- A ready-to-use search component:
+
+```tsx
+"use client";
+
+import {
+  headband,
+  HeadbandProvider,
+  SearchBox,
+  Hits,
+  Stats,
+} from "@headband/react";
+import { headbandConfig } from "../headband.config";
+
+const client = headband(headbandConfig.url, headbandConfig.searchKey);
+
+export function HeadbandSearch() {
+  return (
+    <HeadbandProvider client={client} index={headbandConfig.defaultIndex}>
+      <SearchBox placeholder={`Search products...`} />
+      <Stats />
+      <Hits />
+    </HeadbandProvider>
+  );
+}
+```
+
+## License
+
+MIT

package/dist/index.js

@@ -0,0 +1,259 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/init.ts
+var import_prompts = __toESM(require("prompts"));
+var import_picocolors = __toESM(require("picocolors"));
+var import_path2 = require("path");
+
+// src/utils.ts
+var import_fs = require("fs");
+var import_child_process = require("child_process");
+var import_path = require("path");
+function detectPackageManager(cwd) {
+  if ((0, import_fs.existsSync)((0, import_path.join)(cwd, "pnpm-lock.yaml"))) return "pnpm";
+  if ((0, import_fs.existsSync)((0, import_path.join)(cwd, "yarn.lock"))) return "yarn";
+  if ((0, import_fs.existsSync)((0, import_path.join)(cwd, "bun.lockb"))) return "bun";
+  return "npm";
+}
+function getInstallCommand(pm, pkg) {
+  switch (pm) {
+    case "pnpm":
+      return `pnpm add ${pkg}`;
+    case "yarn":
+      return `yarn add ${pkg}`;
+    case "bun":
+      return `bun add ${pkg}`;
+    default:
+      return `npm install ${pkg}`;
+  }
+}
+function runCommand(command2, cwd) {
+  (0, import_child_process.execSync)(command2, { cwd, stdio: "inherit" });
+}
+function hasSrcDir(cwd) {
+  return (0, import_fs.existsSync)((0, import_path.join)(cwd, "src"));
+}
+function writeFileSafe(filePath, content) {
+  const dir = (0, import_path.dirname)(filePath);
+  if (!(0, import_fs.existsSync)(dir)) {
+    (0, import_fs.mkdirSync)(dir, { recursive: true });
+  }
+  (0, import_fs.writeFileSync)(filePath, content, "utf-8");
+}
+function generateConfig(opts) {
+  return `export const headbandConfig = {
+  url: "${opts.url}",
+  searchKey: process.env.NEXT_PUBLIC_HEADBAND_KEY || "${opts.searchKey}",
+  defaultIndex: "${opts.defaultIndex}",
+};
+`;
+}
+function generateSearchComponent(opts) {
+  return `"use client";
+
+import {
+  headband,
+  HeadbandProvider,
+  SearchBox,
+  Hits,
+  Stats,
+} from "@headband/react";
+import { headbandConfig } from "${opts.configImportPath}";
+
+const client = headband(headbandConfig.url, headbandConfig.searchKey);
+
+export function HeadbandSearch() {
+  return (
+    <HeadbandProvider client={client} index={headbandConfig.defaultIndex}>
+      <SearchBox placeholder={\`Search ${opts.defaultIndex}...\`} />
+      <Stats />
+      <Hits />
+    </HeadbandProvider>
+  );
+}
+`;
+}
+
+// src/init.ts
+async function init(options = {}) {
+  const cwd = process.cwd();
+  console.log();
+  console.log(import_picocolors.default.bold(import_picocolors.default.cyan("  Setting up Headband search...")));
+  console.log();
+  const onCancel = () => {
+    console.log();
+    console.log(import_picocolors.default.yellow("Setup cancelled."));
+    process.exit(0);
+  };
+  let url = "https://headband.dev";
+  let searchKey = "";
+  let defaultIndex = "products";
+  if (options.yes) {
+    console.log(import_picocolors.default.dim("  Using defaults (--yes flag)"));
+    searchKey = "hb_src_your_key_here";
+  } else {
+    const answers = await (0, import_prompts.default)(
+      [
+        {
+          type: "text",
+          name: "url",
+          message: "Headband URL",
+          initial: "https://headband.dev",
+          validate: (v) => v.startsWith("http://") || v.startsWith("https://") ? true : "Must be a valid URL (http:// or https://)"
+        },
+        {
+          type: "text",
+          name: "searchKey",
+          message: "Paste your search API key",
+          hint: "hb_src_... or hb_adm_...",
+          validate: (v) => {
+            if (!v) return "API key is required";
+            if (!v.startsWith("hb_src_") && !v.startsWith("hb_adm_")) {
+              return "Key must start with hb_src_ or hb_adm_";
+            }
+            return true;
+          }
+        },
+        {
+          type: "text",
+          name: "defaultIndex",
+          message: "Which index to search?",
+          initial: "products",
+          hint: "e.g. products, movies, articles",
+          validate: (v) => v.trim() ? true : "Index name is required"
+        }
+      ],
+      { onCancel }
+    );
+    url = answers.url;
+    searchKey = answers.searchKey;
+    defaultIndex = answers.defaultIndex;
+  }
+  const pm = detectPackageManager(cwd);
+  console.log();
+  console.log(
+    import_picocolors.default.dim(`  Detected package manager: ${import_picocolors.default.bold(pm)}`)
+  );
+  console.log();
+  console.log(import_picocolors.default.cyan("  Installing @headband/react..."));
+  console.log();
+  try {
+    const installCmd = getInstallCommand(pm, "@headband/react");
+    runCommand(installCmd, cwd);
+  } catch {
+    console.log();
+    console.log(
+      import_picocolors.default.yellow(
+        "  Could not install @headband/react automatically."
+      )
+    );
+    console.log(
+      import_picocolors.default.dim(
+        `  Run manually: ${getInstallCommand(pm, "@headband/react")}`
+      )
+    );
+  }
+  const useSrc = hasSrcDir(cwd);
+  const componentsDir = useSrc ? (0, import_path2.join)(cwd, "src", "components") : (0, import_path2.join)(cwd, "components");
+  const configImportPath = useSrc ? "../headband.config" : "../headband.config";
+  const configPath = (0, import_path2.join)(cwd, "headband.config.ts");
+  const configContent = generateConfig({ url, searchKey, defaultIndex });
+  writeFileSafe(configPath, configContent);
+  const componentPath = (0, import_path2.join)(componentsDir, "headband-search.tsx");
+  const componentContent = generateSearchComponent({
+    defaultIndex,
+    configImportPath
+  });
+  writeFileSafe(componentPath, componentContent);
+  console.log();
+  console.log(import_picocolors.default.green(import_picocolors.default.bold("  Headband is ready!")));
+  console.log();
+  console.log(import_picocolors.default.dim("  Created files:"));
+  console.log(`    ${import_picocolors.default.cyan("headband.config.ts")} \u2014 search configuration`);
+  console.log(
+    `    ${import_picocolors.default.cyan(
+      useSrc ? "src/components/headband-search.tsx" : "components/headband-search.tsx"
+    )} \u2014 example search component`
+  );
+  console.log();
+  console.log(import_picocolors.default.dim("  Recommended: add your API key to .env.local:"));
+  console.log();
+  console.log(
+    import_picocolors.default.yellow(`    NEXT_PUBLIC_HEADBAND_KEY=${searchKey}`)
+  );
+  console.log();
+  console.log(import_picocolors.default.dim("  Next steps:"));
+  console.log(`    1. Import ${import_picocolors.default.cyan("<HeadbandSearch />")} into a page`);
+  console.log(
+    `    2. Move your API key to ${import_picocolors.default.cyan(".env.local")} for safety`
+  );
+  console.log(
+    `    3. Check the docs at ${import_picocolors.default.cyan("https://headband.dev/docs")}`
+  );
+  console.log();
+}
+
+// src/index.ts
+var args = process.argv.slice(2);
+var flags = new Set(args.filter((a) => a.startsWith("-")));
+var positional = args.filter((a) => !a.startsWith("-"));
+var command = positional[0];
+function printHelp() {
+  console.log(`
+  @headband/cli \u2014 Set up Headband search in your project
+
+  Usage:
+    npx @headband/cli init [options]
+
+  Commands:
+    init        Set up Headband in the current project
+
+  Options:
+    --yes       Skip prompts and use defaults
+    --help      Show this help message
+
+  Examples:
+    npx @headband/cli init
+    npx @headband/cli init --yes
+`);
+}
+async function main() {
+  if (flags.has("--help") || flags.has("-h") || command === "help") {
+    printHelp();
+    process.exit(0);
+  }
+  if (!command || command === "init") {
+    await init({ yes: flags.has("--yes") || flags.has("-y") });
+  } else {
+    console.error(`Unknown command: ${command}`);
+    printHelp();
+    process.exit(1);
+  }
+}
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@headband/cli",
+  "version": "0.1.0",
+  "description": "CLI tool for setting up Headband search in any project",
+  "bin": {
+    "headband": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "dependencies": {
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "headband",
+    "search",
+    "cli",
+    "setup",
+    "meilisearch",
+    "elasticsearch",
+    "typesense"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zvndev/headband",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://headband.dev",
+  "license": "MIT"
+}