@corenel/sidecar 0.1.2 → 0.1.4

package/README.md

@@ -25,7 +25,7 @@ match the site you're connecting from (the app fills it in for you).
 | `--allow-origin <url>` | _(none)_ | Browser origin allowed to connect. Required for a web page. Repeatable. |
 | `--port <n>` | `4858` | Port to listen on. |
 | `--root <dir>` | cwd | Root the file tools are confined to. |
-| `--allow-shell` | off | Enable the `shell_exec` tool (RCE on your machine — opt-in). |
+| `--allow-shell` | off | Enable the `sidecar_shell_exec` tool (RCE on your machine — opt-in). |
 | `--host <addr>` | `127.0.0.1` | Bind address. Non-loopback is reachable off-box; keep the token secret. |
 | `--tls-cert <f>` `--tls-key <f>` | _(none)_ | Serve `wss://` (needed for a remote sidecar from an https page). |
 
@@ -35,6 +35,6 @@ match the site you're connecting from (the app fills it in for you).
   allowed Origin.
 - The HTTP proxy (for local LLMs) only reaches **loopback** hosts — it can't be used as
   an SSRF pivot to internal services.
-- `shell_exec` is off unless you pass `--allow-shell`.
+- `sidecar_shell_exec` is off unless you pass `--allow-shell`.
 
 Licensed under Elastic-2.0.

package/dist/cli.js

@@ -10,6 +10,13 @@ import { spawn as spawn4 } from "node:child_process";
 import { WebSocketServer } from "ws";
 import { createServer as createHttpsServer } from "node:https";
 
+// ../protocol/stateDir.ts
+var DEFAULT_STATE_DIR = ".corenel";
+var dirName = DEFAULT_STATE_DIR;
+function stateDirName() {
+  return dirName;
+}
+
 // ../protocol/sidecar.ts
 var SIDECAR_PROTOCOL = 1;
 function isLoopbackHost(host) {
@@ -39,6 +46,10 @@ var SidecarServer = class {
   authed = false;
   hostSeq = 0;
   hostPending = /* @__PURE__ */ new Map();
+  /** The connected host's dot-dir name, from `hello.stateDir` (informational —
+   * doesn't change any sidecar behavior yet; reserved for future workspace-state
+   * features that need to know the host's dir name). */
+  hostStateDir = ".corenel";
   constructor(opts) {
     this.opts = opts;
     this.ch = opts.channel;
@@ -88,7 +99,8 @@ var SidecarServer = class {
       return;
     }
     this.authed = true;
-    this.opts.log?.(`paired \u2014 ${this.tools.size} ${this.tools.size === 1 ? "tool" : "tools"} advertised`);
+    this.hostStateDir = m.stateDir ?? ".corenel";
+    this.opts.log?.(`paired \u2014 ${this.tools.size} ${this.tools.size === 1 ? "tool" : "tools"} advertised (host dir: ${this.hostStateDir})`);
     const tools = [...this.tools.values()].map(({ run: _run, ...decl }) => decl);
     this.ch.send({ t: "welcome", tools, features: ["http-proxy"], ...this.opts.info ? { info: this.opts.info } : {} });
   }
@@ -279,6 +291,7 @@ function startSidecar(opts) {
     wss2.on("connection", onConnection);
     return new Promise((resolveHandle, reject) => {
       httpsServer.on("error", reject);
+      wss2.on("error", reject);
       httpsServer.listen(opts.port, host, () => {
         const addr = httpsServer.address();
         const boundPort = typeof addr === "object" && addr ? addr.port : opts.port;
@@ -348,7 +361,7 @@ var MAX_READ_BYTES = 16 * 1024 * 1024;
 function nodeFsTools(roots) {
   return [
     {
-      name: "fs_read_file",
+      name: "sidecar_fs_read_file",
       description: "Read a UTF-8 text file from the sidecar machine, relative to a pre-approved root.",
       parameters: {
         type: "object",
@@ -367,7 +380,7 @@ function nodeFsTools(roots) {
       }
     },
     {
-      name: "fs_write_file",
+      name: "sidecar_fs_write_file",
       description: "Write a UTF-8 text file on the sidecar machine, relative to a pre-approved root.",
       parameters: {
         type: "object",
@@ -389,7 +402,7 @@ function nodeFsTools(roots) {
       }
     },
     {
-      name: "fs_read_bytes",
+      name: "sidecar_fs_read_bytes",
       description: "Read a file from the sidecar machine as base64 (for previewing media/binary the text read would mangle), relative to a pre-approved root.",
       parameters: {
         type: "object",
@@ -408,7 +421,7 @@ function nodeFsTools(roots) {
       }
     },
     {
-      name: "fs_list_dir",
+      name: "sidecar_fs_list_dir",
       description: "List the entries of a directory on the sidecar machine, relative to a pre-approved root.",
       parameters: {
         type: "object",
@@ -429,7 +442,7 @@ var MAX_TIMEOUT_MS = 3e5;
 var MAX_OUTPUT = 1e5;
 function nodeShellTool(roots) {
   return {
-    name: "shell_exec",
+    name: "sidecar_shell_exec",
     description: "Run a shell command on the sidecar machine (commands a browser cannot spawn). Runs in a pre-approved root by default; returns the exit status plus combined stdout/stderr.",
     parameters: {
       type: "object",
@@ -496,7 +509,7 @@ import { randomBytes } from "node:crypto";
 import { homedir } from "node:os";
 import { join } from "node:path";
 function corenelDir() {
-  return join(homedir(), ".corenel");
+  return join(homedir(), stateDirName());
 }
 function tokenPath() {
   return join(corenelDir(), "daemon.token");
@@ -823,9 +836,27 @@ function parseArgs(argv) {
     else if (a === "--tunnel-name") out.tunnelName = argv[++i];
     else if (a === "--open") out.open = true;
     else if (a === "--app-url") out.appUrl = argv[++i];
+    else if (a === "--sidecar" || a === "start" || a === "--") {
+    } else throw new Error(`unknown argument: ${a}
+valid flags: ${KNOWN_FLAGS.join(" ")}`);
   }
   return out;
 }
+var KNOWN_FLAGS = [
+  "--port",
+  "--host",
+  "--root",
+  "--allow-origin",
+  "--allow-shell",
+  "--allow-lan",
+  "--tls-cert",
+  "--tls-key",
+  "--self-signed",
+  "--tunnel",
+  "--tunnel-name",
+  "--open",
+  "--app-url"
+];
 var isIp2 = (s) => /^\d{1,3}(?:\.\d{1,3}){3}$/.test(s);
 function openBrowser(url) {
   const p = process.platform;
@@ -905,7 +936,7 @@ async function main() {
     [
       `corenel sidecar listening on ${scheme}://${handle.host}:${handle.port}`,
       args.roots.length === 1 ? `  root:  ${args.roots[0]}` : `  roots: ${args.roots.join("\n         ")}   (${args.roots.length} approved; pick the active one in the app)`,
-      `  tools: fs_read/write/list${args.allowShell ? " + shell_exec" : "  (shell off; pass --allow-shell to enable)"}`,
+      `  tools: sidecar_fs_read/write/list${args.allowShell ? " + sidecar_shell_exec" : "  (shell off; pass --allow-shell to enable)"}`,
       `  token: ${token}  (also at ${tokenPath()})`,
       tunnelWss ? `  connect at: ${tunnelWss}   (public ${args.tunnel} tunnel${args.tunnelName ? ", stable" : ""} \u2014 pair from any device with this URL + the token)` : `  connect at: ${connectUrls.join("  ")}`,
       `  origins: ${allowedOrigins.join(", ")}${args.allowLan ? "  + any private-LAN origin (--allow-lan)" : args.allowOrigins.length ? "" : "  (canonical defaults; pass --allow-origin to add dev/self-hosted)"}`,
@@ -932,7 +963,9 @@ async function main() {
   process.on("SIGTERM", shutdown);
 }
 main().catch((e) => {
-  process.stderr.write(`corenel-sidecar: ${e instanceof Error ? e.message : String(e)}
+  const code = e?.code;
+  const msg = code === "EADDRINUSE" ? `port already in use \u2014 another sidecar may be running. Stop it, or pass --port <n>.` : e instanceof Error ? e.message : String(e);
+  process.stderr.write(`corenel-sidecar: ${msg}
 `);
   process.exit(1);
 });

package/package.json

@@ -1,41 +1,48 @@
-{
-  "name": "@corenel/sidecar",
-  "version": "0.1.2",
-  "type": "module",
-  "license": "Elastic-2.0",
-  "description": "Prompd sidecar — a local capability server. Run it next to Prompd (prompd.app) so the browser app can reach your machine: local LLMs (Ollama/LM Studio/vLLM) without CORS, your filesystem, and (opt-in) shell.",
-  "keywords": ["prompd", "corenel", "sidecar", "ollama", "local-llm", "cors"],
-  "bin": {
-    "corenel-sidecar": "dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "node build.mjs",
-    "prepublishOnly": "node build.mjs",
-    "start": "tsx src/cli.ts",
-    "typecheck": "tsc --noEmit",
-    "verify": "tsx src/verify.ts"
-  },
-  "dependencies": {
-    "selfsigned": "^2.4.1",
-    "ws": "^8.18.0"
-  },
-  "devDependencies": {
-    "@corenel/protocol": "workspace:*",
-    "@corenel/harness": "workspace:*",
-    "@types/node": "^24.13.1",
-    "@types/ws": "^8.5.13",
-    "esbuild": "^0.21.5",
-    "tsx": "^4.19.2",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "@corenel/sidecar",
+  "version": "0.1.4",
+  "type": "module",
+  "license": "Elastic-2.0",
+  "description": "Prompd sidecar — a local capability server. Run it next to Prompd (prompd.app) so the browser app can reach your machine: local LLMs (Ollama/LM Studio/vLLM) without CORS, your filesystem, and (opt-in) shell.",
+  "keywords": [
+    "prompd",
+    "corenel",
+    "sidecar",
+    "ollama",
+    "local-llm",
+    "cors"
+  ],
+  "bin": {
+    "corenel-sidecar": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node build.mjs",
+    "prepublishOnly": "node build.mjs",
+    "start": "tsx src/cli.ts",
+    "typecheck": "tsc --noEmit",
+    "verify": "tsx src/verify.ts"
+  },
+  "dependencies": {
+    "selfsigned": "^2.4.1",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@corenel/protocol": "workspace:*",
+    "@corenel/harness": "workspace:*",
+    "@types/node": "^24.13.1",
+    "@types/ws": "^8.5.13",
+    "esbuild": "^0.21.5",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.3"
+  }
+}