@hachej/boring-ui-cli 0.1.30 → 0.1.32

package/README.md

@@ -92,14 +92,17 @@ pnpm --filter @hachej/boring-ui-cli build
 npx ./packages/cli/dist/index.js
 ```
 
-### Scaffold a Plugin
+### Plugins
+
+Plugin authoring operations live in the dedicated plugin CLI:
 
 ```bash
-boring-ui plugin create my-plugin --path plugins
+boring-ui-plugin create my-package-plugin --path plugins
+boring-ui-plugin scaffold my-runtime-plugin "$BORING_AGENT_WORKSPACE_ROOT"
+boring-ui-plugin verify my-runtime-plugin "$BORING_AGENT_WORKSPACE_ROOT"
+boring-ui-plugin test my-runtime-plugin
 ```
 
-This copies the bundled plugin template from `templates/plugin/`, renames the sample identifiers, and creates `plugins/my-plugin`.
-
 ---
 
 ## Authentication

package/dist/server/cli.js

@@ -1,17 +1,11 @@
 #!/usr/bin/env node
 import { execSync } from "node:child_process";
 import {
-  cpSync,
   existsSync,
-  mkdirSync,
-  readdirSync,
-  readFileSync,
-  renameSync,
-  statSync,
-  writeFileSync
+  readFileSync
 } from "node:fs";
 import { createRequire } from "node:module";
-import { basename, dirname, isAbsolute, join, relative, resolve } from "node:path";
+import { basename, dirname, isAbsolute, join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import { parseArgs } from "node:util";
 import { createLocalWorkspaceRegistry } from "./localWorkspaces.js";
@@ -27,7 +21,7 @@ const MODE_MAP = {
   // bwrap isolated, no network (Linux only)
 };
 const require2 = createRequire(import.meta.url);
-const CLI_PACKAGE_NAME = "@hachej/boring-ui-cli";
+const PLUGIN_CLI_PACKAGE_NAME = "@hachej/boring-ui-plugin-cli";
 const CLI_VERSION = (() => {
   try {
     const pkg = require2("../../package.json");
@@ -81,16 +75,30 @@ function resolveBoringUiCliPackageRoot() {
   const __dirname = dirname(fileURLToPath(import.meta.url));
   return resolve(__dirname, "..", "..");
 }
-function createBoringUiCliRuntimePlugin(packageRoot = resolveBoringUiCliPackageRoot()) {
+function isUsableBoringUiPluginCliPackageRoot(candidate) {
+  try {
+    const pkg = JSON.parse(readFileSync(join(candidate, "package.json"), "utf8"));
+    return pkg.name === PLUGIN_CLI_PACKAGE_NAME && existsSync(join(candidate, "dist", "bin.js"));
+  } catch {
+    return false;
+  }
+}
+function resolveBoringUiPluginCliPackageRoot() {
+  const cliRoot = resolveBoringUiCliPackageRoot();
+  const candidate = resolve(cliRoot, "..", "plugin-cli");
+  return isUsableBoringUiPluginCliPackageRoot(candidate) ? candidate : null;
+}
+function createBoringUiCliRuntimePlugin() {
+  const useLocal = process.env.BORING_USE_LOCAL_PACKAGES === "1";
+  const packageRoot = useLocal ? resolveBoringUiPluginCliPackageRoot() : null;
   return {
-    id: "boring-ui-cli-runtime",
+    id: "boring-ui-plugin-cli-runtime",
     provisioning: {
       nodePackages: [{
-        id: "boring-ui-cli",
-        packageName: CLI_PACKAGE_NAME,
-        packageRoot,
-        version: CLI_VERSION,
-        expectedBins: ["boring-ui"]
+        id: "boring-ui-plugin-cli",
+        packageName: PLUGIN_CLI_PACKAGE_NAME,
+        ...packageRoot ? { packageRoot } : { version: CLI_VERSION },
+        expectedBins: ["boring-ui-plugin"]
       }]
     }
   };
@@ -124,6 +132,8 @@ function ensureFrontendBuilt(publicDir) {
 }
 async function registerStatic(app, publicDir) {
   ensureFrontendBuilt(publicDir);
+  const { default: fastifyCompress } = await import("@fastify/compress");
+  await app.register(fastifyCompress, { global: true, encodings: ["br", "gzip"], threshold: 1024 });
   const { default: fastifyStatic } = await import("@fastify/static");
   await app.register(fastifyStatic, {
     root: publicDir,
@@ -142,10 +152,6 @@ const HELP_TEXT = [
   "Commands:",
   "  boring-ui [workspace]                 Start the workspace UI for a folder",
   "  boring-ui workspaces <subcommand>     Manage saved local workspaces",
-  "  boring-ui scaffold-plugin <name> [workspace]",
-  "                                       Scaffold a hot-reloadable plugin",
-  "  boring-ui verify-plugin [name] [workspace]",
-  "                                       Validate plugin manifests/files",
   "",
   "Options:",
   "  -p, --port <port>       HTTP port (default: 5200)",
@@ -327,6 +333,7 @@ async function createFolderModeApp(opts) {
     });
   });
   app.get("/api/v1/workspace/meta", async () => ({
+    workspaceId: "default",
     workspaceRoot,
     projectName,
     version: CLI_VERSION,
@@ -547,6 +554,7 @@ async function createWorkspacesModeApp(opts) {
     ]
   });
   await app.register(workspaceServer.uiRoutes, {
+    getWorkspaceId: async (request) => (await workspaceFromRequest(request)).id,
     getBridge: async (request) => getBridge((await workspaceFromRequest(request)).id)
   });
   app.get("/api/v1/runtime-plugin-diagnostics", async (request) => {
@@ -674,109 +682,6 @@ async function startWorkspacesMode(opts) {
   if (await checkAuth() === 0) console.log(AUTH_GUIDE);
   openBrowser(initialUrl);
 }
-function findRepoRoot(from) {
-  let current = from;
-  while (true) {
-    if (existsSync(join(current, "pnpm-workspace.yaml"))) return current;
-    const parent = dirname(current);
-    if (parent === current) return null;
-    current = parent;
-  }
-}
-function walkDir(dir, base, out = []) {
-  for (const entry of readdirSync(dir)) {
-    if (entry === "node_modules" || entry === ".git" || entry === "dist") continue;
-    const fullPath = join(dir, entry);
-    const stat = statSync(fullPath);
-    if (stat.isDirectory()) {
-      walkDir(fullPath, base, out);
-      continue;
-    }
-    out.push(relative(base, fullPath));
-  }
-  return out;
-}
-function replaceInFile(filePath, replacements) {
-  let content = readFileSync(filePath, "utf8");
-  for (const [from, to] of Object.entries(replacements)) {
-    content = content.replaceAll(from, to);
-  }
-  writeFileSync(filePath, content, "utf8");
-}
-async function handlePluginCommand(opts) {
-  const subcommand = opts.positionals[1];
-  if (subcommand !== "create") {
-    console.log("Usage: boring-ui plugin create <name> [--path <dir>]");
-    console.log("");
-    console.log("Scaffold a new plugin from the template.");
-    console.log("");
-    console.log("Arguments:");
-    console.log("  <name>        Plugin name (e.g. my-plugin)");
-    console.log("  --path        Parent directory for the new plugin (default: plugins/)");
-    return;
-  }
-  const name = opts.positionals[2];
-  if (!name) throw new Error("usage: boring-ui plugin create <name>");
-  const __dirname = dirname(fileURLToPath(import.meta.url));
-  const packageRoot = resolve(__dirname, "..", "..");
-  const templateDir = join(packageRoot, "templates", "plugin");
-  if (!existsSync(templateDir)) {
-    throw new Error(
-      `Plugin template not found at ${templateDir}.
-This build may not include the plugin template.`
-    );
-  }
-  const repoRoot = findRepoRoot(process.cwd());
-  const customPath = opts.args.path;
-  const targetParent = customPath ? resolve(customPath) : join(repoRoot ?? process.cwd(), "plugins");
-  const targetDir = join(targetParent, name);
-  if (existsSync(targetDir)) {
-    throw new Error(`Directory already exists: ${targetDir}`);
-  }
-  const id = name.toLowerCase().replace(/[^a-z0-9-]/g, "-").replace(/^-+|-+$/g, "");
-  if (!id) throw new Error(`invalid plugin name: ${name}`);
-  const symbolBase = id.replace(/-plugin$/, "") || id;
-  const pascalBase = symbolBase.split(/[-_]+/).map((seg) => seg.charAt(0).toUpperCase() + seg.slice(1)).join("");
-  const camelBase = pascalBase.charAt(0).toLowerCase() + pascalBase.slice(1);
-  const upperBase = symbolBase.replace(/-/g, "_").toUpperCase();
-  console.log(`Scaffolding plugin "${id}" at ${targetDir}`);
-  mkdirSync(targetParent, { recursive: true });
-  cpSync(templateDir, targetDir, { recursive: true });
-  const files = walkDir(targetDir, targetDir);
-  const pkgName = `@hachej/boring-${id}`;
-  for (const file of files) {
-    const fullPath = join(targetDir, file);
-    replaceInFile(fullPath, {
-      "@hachej/boring-plugin-template": pkgName,
-      "sample-plugin": id,
-      "sample-panel": `${id}-panel`,
-      "sample.open": `${id}.open`,
-      "sample:": `${id}:`,
-      '"sample"': `"${id}"`,
-      "SAMPLE": upperBase,
-      "Sample": pascalBase,
-      "sampleSurfaceResolver": `${camelBase}SurfaceResolver`,
-      "samplePanel": `${camelBase}Panel`
-    });
-    if (file.includes("samplePlugin")) {
-      const newFile = file.replace(/samplePlugin/g, `${camelBase}Plugin`);
-      const oldPath = join(targetDir, file);
-      const newPath = join(targetDir, newFile);
-      if (oldPath !== newPath) {
-        mkdirSync(dirname(newPath), { recursive: true });
-        renameSync(oldPath, newPath);
-      }
-    }
-  }
-  console.log("");
-  console.log(`\u2713 Created plugin \`${id}\` at ${relative(process.cwd(), targetDir)}`);
-  console.log("");
-  console.log("Next steps:");
-  console.log(`  cd ${relative(process.cwd(), targetDir)}`);
-  console.log("  pnpm install");
-  console.log(`  pnpm --filter ${pkgName} typecheck`);
-  console.log(`  pnpm --filter ${pkgName} test`);
-}
 async function handleWorkspacesCommand(opts) {
   const registry = createLocalWorkspaceRegistry();
   const subcommand = opts.positionals[1];
@@ -828,6 +733,10 @@ async function runCli(options) {
       name: { type: "string", short: "n" },
       path: { type: "string" },
       json: { type: "boolean" },
+      url: { type: "string" },
+      workspace: { type: "string" },
+      "panel-id": { type: "string" },
+      "timeout-ms": { type: "string" },
       help: { type: "boolean", short: "h" }
     },
     allowPositionals: true,
@@ -849,15 +758,8 @@ async function runCli(options) {
     cliMode = rawMode;
     mode = MODE_MAP[cliMode];
   } else {
-    const agent = await import("@hachej/boring-agent/server");
-    const detected = agent.autoDetectMode();
-    if (detected === "local") {
-      cliMode = "local-sandbox";
-      mode = "local";
-    } else {
-      cliMode = "local";
-      mode = "direct";
-    }
+    cliMode = "local";
+    mode = "direct";
   }
   const base = {
     publicDir: options.publicDir,
@@ -866,13 +768,6 @@ async function runCli(options) {
     cliMode,
     mode
   };
-  if (positionals[0] === "plugin") {
-    await handlePluginCommand({
-      positionals,
-      args: { path: args.path }
-    });
-    return;
-  }
   if (positionals[0] === "workspaces") {
     await handleWorkspacesCommand({
       ...base,
@@ -881,105 +776,11 @@ async function runCli(options) {
     });
     return;
   }
-  if (positionals[0] === "plugin-status") {
-    handlePluginStatusCommand({ json: args.json === true });
-    return;
-  }
-  if (positionals[0] === "scaffold-plugin") {
-    await handleScaffoldPluginCommand({ positionals });
-    return;
-  }
-  if (positionals[0] === "verify-plugin") {
-    await handleVerifyPluginCommand({ positionals });
-    return;
-  }
   await startFolderMode({
     ...base,
     folderArg: positionals[0]
   });
 }
-function defaultWorkspaceRoot() {
-  return process.env.BORING_AGENT_WORKSPACE_ROOT ?? process.cwd();
-}
-function workspaceLocalPluginRootsEnabled() {
-  const raw = process.env.BORING_AGENT_WORKSPACE_LOCAL_PLUGIN_ROOTS;
-  if (raw == null || raw.trim() === "") return true;
-  return !["0", "false", "no", "off"].includes(raw.trim().toLowerCase());
-}
-function buildPluginStatus() {
-  const workspaceRoot = resolve(defaultWorkspaceRoot());
-  const enabled = workspaceLocalPluginRootsEnabled();
-  return {
-    workspaceLocalPluginRoots: enabled,
-    workspaceRoot,
-    extensionsDir: join(workspaceRoot, ".pi", "extensions"),
-    reloadSupported: enabled,
-    ...enabled ? {} : {
-      reason: "This runtime writes to a remote sandbox; host-side plugin discovery cannot load .pi/extensions from there."
-    }
-  };
-}
-function handlePluginStatusCommand(opts) {
-  const status = buildPluginStatus();
-  if (opts.json) {
-    console.log(JSON.stringify(status, null, 2));
-    return;
-  }
-  console.log(status.workspaceLocalPluginRoots ? `workspace-local plugin roots enabled: ${status.extensionsDir}` : `workspace-local plugin roots disabled: ${status.reason}`);
-}
-async function handleVerifyPluginCommand(opts) {
-  const maybeName = opts.positionals[1];
-  const maybeWorkspace = opts.positionals[2];
-  const looksLikePath = maybeName && (maybeName.includes("/") || maybeName.startsWith("."));
-  const name = looksLikePath ? void 0 : maybeName;
-  const workspaceRoot = resolve(maybeWorkspace ?? (looksLikePath ? maybeName : defaultWorkspaceRoot()));
-  const { findHintForError, formatVerifyResult, verifyPlugin } = await import("./verifyPlugin.js");
-  const result = verifyPlugin({ workspaceRoot, ...name ? { name } : {} });
-  console.log(formatVerifyResult(result));
-  if (!result.ok) {
-    const hints = [];
-    for (const outcome of result.outcomes) {
-      for (const err of outcome.errors) {
-        const hint = findHintForError(err);
-        if (hint) hints.push(`  hint (${outcome.id}): ${hint}`);
-      }
-    }
-    if (hints.length > 0) {
-      console.log("");
-      console.log("Suggestions:");
-      for (const hint of hints) console.log(hint);
-    }
-    process.exit(1);
-  }
-}
-async function handleScaffoldPluginCommand(opts) {
-  const name = opts.positionals[1];
-  if (!name) {
-    throw new Error("usage: boring-ui scaffold-plugin <name> [workspace]");
-  }
-  const status = buildPluginStatus();
-  if (!status.workspaceLocalPluginRoots) {
-    throw new Error(`${status.reason} Do not scaffold into .pi/extensions in this runtime.`);
-  }
-  const workspaceRoot = resolve(opts.positionals[2] ?? defaultWorkspaceRoot());
-  const { scaffoldPlugin } = await import("./scaffoldPlugin.js");
-  const result = scaffoldPlugin({ name, workspaceRoot });
-  console.log(`scaffolded ${name}`);
-  console.log(`  dir   ${result.pluginDir}`);
-  for (const file of result.filesCreated) {
-    console.log(`  +     ${file}`);
-  }
-  console.log("");
-  console.log("Next steps:");
-  console.log(`  1. edit front/index.tsx for UI panels/commands/resolvers`);
-  console.log(`  2. add pi.extensions / skills for hot-reloadable agent behavior`);
-  console.log(`  3. bash \`boring-ui verify-plugin\` \u2014 confirms manifests + files are valid`);
-  console.log(`  4. ask the user: /reload`);
-  console.log("");
-  console.log("Advanced server integration:");
-  console.log("  boring.server is boot-time/static composition only. It is NOT hot-registered");
-  console.log("  by /reload for .pi/extensions user plugins; use Pi extensions for agent tools.");
-}
 export {
   createBoringUiCliRuntimePlugin,
   createFolderModeApp,
@@ -987,5 +788,6 @@ export {
   provisionCliWorkspaceRuntime,
   registerStatic,
   resolveBoringUiCliPackageRoot,
+  resolveBoringUiPluginCliPackageRoot,
   runCli
 };