pi-neutrasearch 0.1.1 → 0.2.1

package/README.md

@@ -6,20 +6,35 @@ Token-efficient native indexed filename and path search for [Pi](https://pi.dev)
 
 ## Install
 
-Install Neutrasearch and build its index first, then install the Pi package:
+Install the Pi package:
 
 ```sh
 pi install npm:pi-neutrasearch
 ```
 
-Use `/neutrasearch` inside Pi to confirm executable discovery.
+npm automatically installs the matching Neutrasearch application for Linux x64/ARM64, Windows x64, or macOS x64/ARM64. No separate application download or compiler is required.
+
+Inside Pi, run:
+
+```text
+/neutrasearch-setup
+```
+
+This installs convenient shortcuts and opens the bundled Neutrasearch app:
+
+- Linux: application menu, Desktop, and `~/.local/bin` CLI links
+- Windows: Start Menu and Desktop shortcuts
+- macOS: `~/Applications/Neutrasearch.app` and a Desktop alias
+
+Approve local indexing in the app, then return to Pi. Indexing remains an explicit user action; package installation never scans disks or requests privileges.
+
+Use `/neutrasearch` to inspect installation and index status.
 
 The package resolves, in order:
 
-1. `NEUTRASEARCH_QUERY`
-2. `neutrasearch-query` on `PATH`
-3. `NEUTRASEARCH_BIN`
-4. `neutrasearch` on `PATH`
+1. `NEUTRASEARCH_QUERY` or `NEUTRASEARCH_BIN` when explicitly configured
+2. the OS/architecture-specific binary package installed by npm
+3. `neutrasearch-query` or `neutrasearch` on `PATH`
 
 Set `NEUTRASEARCH_INDEX` to override Neutrasearch's platform-default index path.
 

package/assets/neutrasearch.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="11" fill="#111512"/>
+  <path d="M16 17h23l9 9v21H16z" fill="#1d241f" stroke="#a8ff60" stroke-width="3"/>
+  <path d="M39 17v10h9" fill="none" stroke="#a8ff60" stroke-width="3"/>
+  <circle cx="29" cy="36" r="8" fill="none" stroke="#f2f5f1" stroke-width="3"/>
+  <path d="m35 42 8 8" stroke="#f2f5f1" stroke-width="4" stroke-linecap="square"/>
+</svg>

package/index.js

@@ -1,4 +1,13 @@
-import { compactSearchResult, limits, queryArguments, resolveNeutrasearch, resolveScope } from "./lib.js";
+import { spawn } from "node:child_process";
+import { installShortcuts } from "./shortcuts.js";
+import {
+  compactSearchResult,
+  limits,
+  queryArguments,
+  resolveNeutrasearch,
+  resolveNeutrasearchApp,
+  resolveScope,
+} from "./lib.js";
 
 const TOOL_NAME = "neutrasearch";
 
@@ -17,7 +26,7 @@ function status(binary) {
       ok: false,
       tool: TOOL_NAME,
       error: "Neutrasearch executable not found",
-      setup: "Install Neutrasearch, or set NEUTRASEARCH_QUERY / NEUTRASEARCH_BIN.",
+      setup: "Reinstall pi-neutrasearch to fetch its matching native binary package, or set NEUTRASEARCH_QUERY / NEUTRASEARCH_BIN.",
       token_defaults: { limit: limits.defaultLimit, max_chars: limits.defaultMaxChars },
     };
   }
@@ -26,6 +35,8 @@ function status(binary) {
     tool: TOOL_NAME,
     executable: binary.command,
     executable_kind: binary.kind,
+    bundled_package: binary.packageName || null,
+    app: binary.app || resolveNeutrasearchApp() || null,
     index: process.env.NEUTRASEARCH_INDEX || "platform default",
     default_scope: "current Pi workspace",
     extra_scope_env: "NEUTRASEARCH_PI_ALLOWED_ROOTS",
@@ -159,6 +170,35 @@ export default function register(pi) {
     },
   });
 
+  pi.registerCommand("neutrasearch-setup", {
+    description: "Open the bundled Neutrasearch app to approve and build its index",
+    handler: async (_args, ctx) => {
+      const application = resolveNeutrasearchApp();
+      if (!application) {
+        ctx.ui.notify(
+          "Neutrasearch app is missing. Reinstall pi-neutrasearch or set NEUTRASEARCH_BIN.",
+          "error",
+        );
+        return;
+      }
+      try {
+        const shortcuts = installShortcuts(application);
+        const child = spawn(application, [], {
+          detached: true,
+          stdio: "ignore",
+          windowsHide: false,
+        });
+        child.unref();
+        ctx.ui.notify(
+          `Neutrasearch opened and ${shortcuts.length} shortcuts were installed. Approve local indexing in the app, then return to Pi.`,
+          "info",
+        );
+      } catch (error) {
+        ctx.ui.notify(`Could not open Neutrasearch: ${shortError(error)}`, "error");
+      }
+    },
+  });
+
   pi.registerCommand("neutrasearch", {
     description: "Show Neutrasearch Pi integration status",
     handler: async (_args, ctx) => {

package/lib.js

@@ -1,6 +1,9 @@
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
 
 const DEFAULT_LIMIT = 20;
 const MAX_LIMIT = 200;
@@ -46,25 +49,93 @@ function findOnPath(command, env = process.env, platform = process.platform) {
   return null;
 }
 
-export function resolveNeutrasearch(env = process.env, platform = process.platform) {
-  const candidates = [
+export function bundledPackageName(platform = process.platform, architecture = process.arch) {
+  return {
+    "linux:x64": "neutrasearch-linux-x64",
+    "linux:arm64": "neutrasearch-linux-arm64",
+    "win32:x64": "neutrasearch-windows-x64",
+    "darwin:x64": "neutrasearch-darwin-x64",
+    "darwin:arm64": "neutrasearch-darwin-arm64",
+  }[`${platform}:${architecture}`] || null;
+}
+
+export function resolveBundledInstallation(
+  platform = process.platform,
+  architecture = process.arch,
+  packageResolver = (specifier) => require.resolve(specifier),
+) {
+  const packageName = bundledPackageName(platform, architecture);
+  if (!packageName) return null;
+  try {
+    const packageJson = packageResolver(`${packageName}/package.json`);
+    const root = path.dirname(packageJson);
+    const suffix = platform === "win32" ? ".exe" : "";
+    const installation = {
+      packageName,
+      root,
+      query: path.join(root, "bin", `neutrasearch-query${suffix}`),
+      app: path.join(root, "bin", `neutrasearch${suffix}`),
+      helper: path.join(root, "bin", `neutrasearch-helper${suffix}`),
+      mcp: path.join(root, "bin", `neutrasearch-mcp${suffix}`),
+    };
+    return canExecute(installation.query, platform) && canExecute(installation.app, platform)
+      ? installation
+      : null;
+  } catch {
+    return null;
+  }
+}
+
+export function resolveNeutrasearch(
+  env = process.env,
+  platform = process.platform,
+  architecture = process.arch,
+) {
+  const explicit = [
     env.NEUTRASEARCH_QUERY
       ? { command: env.NEUTRASEARCH_QUERY, prefix: [], kind: "query" }
       : null,
-    { command: "neutrasearch-query", prefix: [], kind: "query" },
     env.NEUTRASEARCH_BIN
       ? { command: env.NEUTRASEARCH_BIN, prefix: ["search"], kind: "launcher" }
       : null,
-    { command: "neutrasearch", prefix: ["search"], kind: "launcher" },
   ].filter(Boolean);
+  for (const candidate of explicit) {
+    const resolved = findOnPath(candidate.command, env, platform);
+    if (resolved) return { ...candidate, command: resolved };
+  }
 
-  for (const candidate of candidates) {
+  const bundled = resolveBundledInstallation(platform, architecture);
+  if (bundled) {
+    return {
+      command: bundled.query,
+      prefix: [],
+      kind: "bundled-query",
+      app: bundled.app,
+      packageName: bundled.packageName,
+    };
+  }
+
+  const pathCandidates = [
+    { command: "neutrasearch-query", prefix: [], kind: "query" },
+    { command: "neutrasearch", prefix: ["search"], kind: "launcher" },
+  ];
+  for (const candidate of pathCandidates) {
     const resolved = findOnPath(candidate.command, env, platform);
     if (resolved) return { ...candidate, command: resolved };
   }
   return null;
 }
 
+export function resolveNeutrasearchApp(env = process.env, platform = process.platform) {
+  if (env.NEUTRASEARCH_BIN) {
+    const explicit = findOnPath(env.NEUTRASEARCH_BIN, env, platform);
+    if (explicit) return explicit;
+  }
+  const bundled = resolveBundledInstallation(platform, process.arch);
+  if (bundled) return bundled.app;
+  return findOnPath("neutrasearch", env, platform);
+}
+
 function canonicalDirectory(input) {
   const resolved = fs.realpathSync(path.resolve(input));
   if (!fs.statSync(resolved).isDirectory()) throw new Error(`scope is not a directory: ${input}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-neutrasearch",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Token-efficient native indexed filename and path search for Pi agents",
   "type": "module",
   "license": "MIT",
@@ -25,6 +25,8 @@
   "files": [
     "index.js",
     "lib.js",
+    "shortcuts.js",
+    "assets",
     "README.md",
     "LICENSE",
     "skills"
@@ -32,6 +34,13 @@
   "engines": {
     "node": ">=20"
   },
+  "optionalDependencies": {
+    "neutrasearch-darwin-arm64": "0.1.0",
+    "neutrasearch-darwin-x64": "0.1.0",
+    "neutrasearch-linux-arm64": "0.1.0",
+    "neutrasearch-linux-x64": "0.1.0",
+    "neutrasearch-windows-x64": "0.1.0"
+  },
   "scripts": {
     "test": "node --test",
     "prepublishOnly": "npm test"

package/shortcuts.js

@@ -0,0 +1,123 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { execFileSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+function quoteDesktop(value) {
+  return `"${String(value).replace(/(["`$\\])/g, "\\$1")}"`;
+}
+
+function shellQuote(value) {
+  return `'${String(value).replaceAll("'", "'\\''")}'`;
+}
+
+function writeExecutable(file, content) {
+  fs.mkdirSync(path.dirname(file), { recursive: true });
+  fs.writeFileSync(file, content, { mode: 0o755 });
+  fs.chmodSync(file, 0o755);
+}
+
+function installLinux(application, home, packageRoot) {
+  const binRoot = path.dirname(application);
+  const icon = path.join(packageRoot, "assets", "neutrasearch.svg");
+  const applications = path.join(home, ".local", "share", "applications");
+  const desktopEntry = path.join(applications, "neutrasearch.desktop");
+  fs.mkdirSync(applications, { recursive: true });
+  const content = [
+    "[Desktop Entry]",
+    "Type=Application",
+    "Version=1.0",
+    "Name=Neutrasearch",
+    "GenericName=Indexed File Search",
+    "Comment=Search indexed filenames and paths without walking folders",
+    `Exec=${quoteDesktop(application)}`,
+    `Icon=${icon}`,
+    "Terminal=false",
+    "Categories=Utility;FileTools;System;",
+    "Keywords=search;files;index;filename;",
+    "StartupNotify=true",
+    "StartupWMClass=neutrasearch",
+    "",
+  ].join("\n");
+  writeExecutable(desktopEntry, content);
+
+  const created = [desktopEntry];
+  const desktop = path.join(home, "Desktop");
+  if (fs.existsSync(desktop)) {
+    const desktopShortcut = path.join(desktop, "Neutrasearch.desktop");
+    writeExecutable(desktopShortcut, content);
+    created.push(desktopShortcut);
+  }
+
+  const localBin = path.join(home, ".local", "bin");
+  fs.mkdirSync(localBin, { recursive: true });
+  for (const name of ["neutrasearch", "neutrasearch-query", "neutrasearch-helper", "neutrasearch-mcp"]) {
+    const source = path.join(binRoot, name);
+    if (!fs.existsSync(source)) continue;
+    const destination = path.join(localBin, name);
+    try { fs.rmSync(destination, { force: true }); } catch {}
+    fs.symlinkSync(source, destination);
+    created.push(destination);
+  }
+  return created;
+}
+
+function installWindows(application, home, runPowerShell) {
+  const script = [
+    "$ErrorActionPreference = 'Stop'",
+    "$shell = New-Object -ComObject WScript.Shell",
+    "$targets = @(",
+    "  [Environment]::GetFolderPath('Programs') + '\\Neutrasearch.lnk',",
+    "  [Environment]::GetFolderPath('Desktop') + '\\Neutrasearch.lnk'",
+    ")",
+    "foreach ($target in $targets) {",
+    "  $shortcut = $shell.CreateShortcut($target)",
+    "  $shortcut.TargetPath = $env:NEUTRASEARCH_APP",
+    "  $shortcut.WorkingDirectory = Split-Path $env:NEUTRASEARCH_APP",
+    "  $shortcut.IconLocation = $env:NEUTRASEARCH_APP",
+    "  $shortcut.Description = 'Indexed filename and path search'",
+    "  $shortcut.Save()",
+    "}",
+  ].join("\n");
+  runPowerShell("powershell.exe", ["-NoProfile", "-NonInteractive", "-Command", script], {
+    env: { ...process.env, HOME: home, NEUTRASEARCH_APP: application },
+    stdio: "ignore",
+  });
+  return ["Windows Start Menu/Neutrasearch.lnk", "Windows Desktop/Neutrasearch.lnk"];
+}
+
+function installMac(application, home) {
+  const app = path.join(home, "Applications", "Neutrasearch.app");
+  const contents = path.join(app, "Contents");
+  const launcher = path.join(contents, "MacOS", "Neutrasearch");
+  writeExecutable(launcher, `#!/bin/sh\nexec ${shellQuote(application)} "$@"\n`);
+  fs.writeFileSync(
+    path.join(contents, "Info.plist"),
+    `<?xml version="1.0" encoding="UTF-8"?>\n<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n<plist version="1.0"><dict><key>CFBundleName</key><string>Neutrasearch</string><key>CFBundleDisplayName</key><string>Neutrasearch</string><key>CFBundleIdentifier</key><string>dev.pi.neutrasearch</string><key>CFBundleExecutable</key><string>Neutrasearch</string><key>CFBundlePackageType</key><string>APPL</string></dict></plist>\n`,
+  );
+  const created = [app];
+  const desktop = path.join(home, "Desktop");
+  if (fs.existsSync(desktop)) {
+    const link = path.join(desktop, "Neutrasearch.app");
+    try { fs.rmSync(link, { recursive: true, force: true }); } catch {}
+    fs.symlinkSync(app, link);
+    created.push(link);
+  }
+  return created;
+}
+
+export function installShortcuts(application, options = {}) {
+  if (!application || !path.isAbsolute(application) || !fs.existsSync(application)) {
+    throw new Error("Neutrasearch application is missing");
+  }
+  const platform = options.platform || process.platform;
+  const home = options.home || os.homedir();
+  const packageRoot = options.packageRoot || path.dirname(fileURLToPath(import.meta.url));
+  if (platform === "linux") return installLinux(application, home, packageRoot);
+  if (platform === "win32") {
+    return installWindows(application, home, options.runPowerShell || execFileSync);
+  }
+  if (platform === "darwin") return installMac(application, home);
+  throw new Error(`shortcut installation is unsupported on ${platform}`);
+}