opencode-dashboard 0.1.0

package/bin/cli.ts

@@ -0,0 +1,332 @@
+#!/usr/bin/env bun
+/**
+ * CLI for the OpenCode Dashboard
+ *
+ * Usage:
+ *   npx opencode-dashboard <command> [options]
+ *
+ * Commands:
+ *   setup [--global|--project]  Install agents and commands
+ *   start [--port 3333]         Start the dashboard server
+ *   stop                        Stop a running dashboard server
+ *   status                      Check if the dashboard server is running
+ *
+ * Options:
+ *   --port, -p            Server port (default: 3333, env: DASHBOARD_PORT)
+ *   --help, -h            Show help
+ *   --version, -v         Show version
+ */
+
+import { join } from "path";
+import { readdir, copyFile, mkdir, stat } from "fs/promises";
+import { createInterface } from "readline";
+import { readPid, removePid, isServerRunning } from "../server/pid";
+
+// ─── Constants ─────────────────────────────────────────────────
+
+const SERVER_ENTRY = join(import.meta.dir, "..", "server", "index.ts");
+const DEFAULT_PORT = 3333;
+const SPAWN_TIMEOUT_MS = 10_000;
+const SPAWN_POLL_INTERVAL_MS = 250;
+
+// ─── Helpers ───────────────────────────────────────────────────
+
+function printHelp(): void {
+  console.log(`
+opencode-dashboard - Real-time Kanban dashboard for OpenCode agent activity
+
+Usage:
+  opencode-dashboard <command> [options]
+
+Commands:
+  setup    Install agents and commands into your OpenCode config
+  start    Start the dashboard server
+  stop     Stop a running dashboard server
+  status   Check if the dashboard server is running
+
+Setup Options:
+  --global              Install to ~/.config/opencode/ (shared across projects)
+  --project             Install to .opencode/ (current project only)
+
+Server Options:
+  --port, -p <port>     Server port (default: ${DEFAULT_PORT}, env: DASHBOARD_PORT)
+
+General:
+  --help, -h            Show this help message
+  --version, -v         Show version
+`.trim());
+}
+
+function printVersion(): void {
+  try {
+    const pkg = require("../package.json");
+    console.log(pkg.version);
+  } catch {
+    console.log("unknown");
+  }
+}
+
+function parsePort(args: string[]): number {
+  const portIdx = args.findIndex((a) => a === "--port" || a === "-p");
+  if (portIdx !== -1 && args[portIdx + 1]) {
+    const port = Number(args[portIdx + 1]);
+    if (Number.isNaN(port) || port < 1 || port > 65535) {
+      console.error(`Error: Invalid port "${args[portIdx + 1]}". Must be 1-65535.`);
+      process.exit(1);
+    }
+    return port;
+  }
+  return Number(process.env.DASHBOARD_PORT) || DEFAULT_PORT;
+}
+
+async function checkHealth(port: number): Promise<boolean> {
+  try {
+    const res = await fetch(`http://localhost:${port}/api/health`, {
+      signal: AbortSignal.timeout(3000),
+    });
+    return res.ok;
+  } catch {
+    return false;
+  }
+}
+
+// ─── Commands ──────────────────────────────────────────────────
+
+async function cmdStart(args: string[]): Promise<void> {
+  const port = parsePort(args);
+
+  // Check if already running
+  const existing = await isServerRunning(true);
+  if (existing) {
+    console.log(`Dashboard server is already running.`);
+    console.log(`  URL: http://localhost:${existing.port}`);
+    console.log(`  PID: ${existing.pid}`);
+    console.log(`  Started: ${existing.startedAt}`);
+    return;
+  }
+
+  console.log(`Starting dashboard server on port ${port}...`);
+
+  // Use Bun.which to find bun reliably (process.execPath may not always be bun)
+  const bunPath = Bun.which("bun") ?? process.execPath;
+
+  try {
+    const proc = Bun.spawn([bunPath, "run", SERVER_ENTRY], {
+      detached: true,
+      stdio: ["ignore", "ignore", "ignore"],
+      env: { ...process.env, DASHBOARD_PORT: String(port) },
+    });
+    proc.unref();
+  } catch (err: any) {
+    console.error(`Failed to start server: ${err?.message ?? err}`);
+    process.exit(1);
+  }
+
+  // Poll for readiness
+  const maxAttempts = Math.ceil(SPAWN_TIMEOUT_MS / SPAWN_POLL_INTERVAL_MS);
+  for (let i = 0; i < maxAttempts; i++) {
+    await Bun.sleep(SPAWN_POLL_INTERVAL_MS);
+    if (await checkHealth(port)) {
+      console.log(`Dashboard running at http://localhost:${port}`);
+      return;
+    }
+  }
+
+  console.error(`Server failed to start within ${SPAWN_TIMEOUT_MS / 1000}s.`);
+  console.error(`Check if port ${port} is already in use.`);
+  process.exit(1);
+}
+
+async function cmdStop(): Promise<void> {
+  const pidData = readPid();
+  if (!pidData) {
+    console.log("No dashboard server found (no PID file).");
+    return;
+  }
+
+  try {
+    process.kill(pidData.pid, "SIGTERM");
+    removePid();
+    console.log(`Dashboard server stopped (PID: ${pidData.pid}).`);
+  } catch (err: any) {
+    if (err?.code === "ESRCH") {
+      removePid();
+      console.log("Dashboard server was not running (stale PID file cleaned up).");
+    } else {
+      console.error(`Failed to stop server: ${err?.message ?? err}`);
+      process.exit(1);
+    }
+  }
+}
+
+async function cmdStatus(): Promise<void> {
+  const pidData = await isServerRunning(false);
+  if (!pidData) {
+    console.log("Dashboard server is not running.");
+    return;
+  }
+
+  // Process is alive, try health endpoint for more detail
+  try {
+    const res = await fetch(`http://localhost:${pidData.port}/api/health`, {
+      signal: AbortSignal.timeout(3000),
+    });
+    if (res.ok) {
+      const health = (await res.json()) as {
+        uptime?: number;
+        plugins?: number;
+        sseClients?: number;
+      };
+      console.log(`Dashboard server is running.`);
+      console.log(`  URL:     http://localhost:${pidData.port}`);
+      console.log(`  PID:     ${pidData.pid}`);
+      console.log(`  Uptime:  ${health.uptime ?? "?"}s`);
+      console.log(`  Plugins: ${health.plugins ?? "?"}`);
+      console.log(`  SSE:     ${health.sseClients ?? "?"} clients`);
+      console.log(`  Started: ${pidData.startedAt}`);
+      return;
+    }
+    console.log(`Dashboard server process exists (PID: ${pidData.pid}) but health check failed.`);
+  } catch {
+    console.log(`Dashboard server process exists (PID: ${pidData.pid}) but is not responding.`);
+  }
+}
+
+// ─── Setup Command ─────────────────────────────────────────────
+
+const SHIPPED_AGENTS_DIR = join(import.meta.dir, "..", "agents");
+const SHIPPED_COMMANDS_DIR = join(import.meta.dir, "..", "commands");
+
+function getGlobalConfigDir(): string {
+  return join(
+    process.env.HOME ?? process.env.USERPROFILE ?? "",
+    ".config",
+    "opencode",
+  );
+}
+
+function getProjectConfigDir(): string {
+  return join(process.cwd(), ".opencode");
+}
+
+async function prompt(question: string): Promise<string> {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase());
+    });
+  });
+}
+
+async function copyDir(
+  srcDir: string,
+  destDir: string,
+  label: string,
+): Promise<string[]> {
+  const installed: string[] = [];
+  try {
+    await mkdir(destDir, { recursive: true });
+    const entries = await readdir(srcDir);
+    for (const entry of entries) {
+      if (!entry.endsWith(".md")) continue;
+      const destPath = join(destDir, entry);
+      // Skip files that already exist (don't overwrite user customizations)
+      try {
+        await stat(destPath);
+        console.log(`  skip  ${entry} (already exists)`);
+        continue;
+      } catch {
+        // File doesn't exist — proceed
+      }
+      await copyFile(join(srcDir, entry), destPath);
+      installed.push(entry);
+      console.log(`  add   ${entry}`);
+    }
+  } catch (err: any) {
+    console.error(`Failed to install ${label}: ${err?.message ?? err}`);
+  }
+  return installed;
+}
+
+async function cmdSetup(args: string[]): Promise<void> {
+  let scope: "global" | "project" | null = null;
+
+  if (args.includes("--global")) {
+    scope = "global";
+  } else if (args.includes("--project")) {
+    scope = "project";
+  } else {
+    // Interactive prompt
+    console.log("\nWhere would you like to install agents and commands?\n");
+    console.log("  g) Global   (~/.config/opencode/)  - shared across all projects");
+    console.log("  p) Project  (.opencode/)            - current project only\n");
+    const answer = await prompt("Choose [g/p]: ");
+    if (answer === "g" || answer === "global") {
+      scope = "global";
+    } else if (answer === "p" || answer === "project") {
+      scope = "project";
+    } else {
+      console.error(`Invalid choice: "${answer}". Use "g" for global or "p" for project.`);
+      process.exit(1);
+    }
+  }
+
+  const baseDir = scope === "global" ? getGlobalConfigDir() : getProjectConfigDir();
+  const agentsDir = join(baseDir, "agents");
+  const commandsDir = join(baseDir, "commands");
+
+  console.log(`\nInstalling to ${baseDir}/\n`);
+
+  // Install agents
+  console.log("Agents:");
+  const agents = await copyDir(SHIPPED_AGENTS_DIR, agentsDir, "agents");
+
+  // Install commands
+  console.log("\nCommands:");
+  const commands = await copyDir(SHIPPED_COMMANDS_DIR, commandsDir, "commands");
+
+  const total = agents.length + commands.length;
+  if (total > 0) {
+    console.log(`\nInstalled ${agents.length} agent(s) and ${commands.length} command(s).`);
+  } else {
+    console.log(`\nNothing new to install — all files already exist.`);
+  }
+
+  console.log(`\nRestart OpenCode to pick up the changes.`);
+  console.log(`Then use /dashboard-start in the TUI to start the dashboard.`);
+}
+
+// ─── Main ──────────────────────────────────────────────────────
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+if (args.includes("--help") || args.includes("-h") || !command) {
+  printHelp();
+  process.exit(command ? 0 : 1);
+}
+
+if (args.includes("--version") || args.includes("-v")) {
+  printVersion();
+  process.exit(0);
+}
+
+switch (command) {
+  case "setup":
+    await cmdSetup(args.slice(1));
+    break;
+  case "start":
+    await cmdStart(args.slice(1));
+    break;
+  case "stop":
+    await cmdStop();
+    break;
+  case "status":
+    await cmdStatus();
+    break;
+  default:
+    console.error(`Unknown command: ${command}`);
+    console.error(`Run "opencode-dashboard --help" for usage.`);
+    process.exit(1);
+}

package/commands/dashboard-start.md

@@ -0,0 +1,5 @@
+---
+description: Start the OpenCode dashboard server
+---
+
+Call the dashboard_start tool to start the dashboard server. Report the result to the user.

package/commands/dashboard-status.md

@@ -0,0 +1,5 @@
+---
+description: Check the OpenCode dashboard server status
+---
+
+Call the dashboard_status tool to check the dashboard server status. Report the result to the user.

package/commands/dashboard-stop.md

@@ -0,0 +1,5 @@
+---
+description: Stop the OpenCode dashboard server
+---
+
+Call the dashboard_stop tool to stop the dashboard server. Report the result to the user.