runlocal 0.4.0 → 0.5.0

package/index.js

@@ -6,7 +6,7 @@ const { parseArgs, createConnection } = require("./lib");
 const BOLD = "\x1b[1m";
 const RESET = "\x1b[0m";
 
-const { port, host, apiKey, subdomain } = parseArgs(process.argv.slice(2));
+const { port, host, apiKey } = parseArgs(process.argv.slice(2));
 
 console.log(`${BOLD}runlocal${RESET} — expose localhost:${port} to the internet`);
-createConnection({ host, port, apiKey, subdomain, WebSocket });
+createConnection({ host, port, apiKey, WebSocket });

package/lib.js

@@ -1,4 +1,7 @@
 const http = require("http");
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
 
 const GREEN = "\x1b[32m";
 const CYAN = "\x1b[36m";
@@ -14,37 +17,50 @@ const TIPS = [
   "Forward webhooks to multiple URLs at once with runlater.eu",
 ];
 
+function readApiKeyFile() {
+  try {
+    return fs.readFileSync(path.join(os.homedir(), ".runlater", "api-key"), "utf8").trim();
+  } catch {
+    return null;
+  }
+}
+
 function parseArgs(argv) {
   let port = 3000;
   let host = process.env.RUNLOCAL_HOST || "wss://runlocal.eu";
-  let apiKey = process.env.RUNLATER_API_KEY || null;
-  let subdomain = null;
+  let apiKey = process.env.RUNLATER_API_KEY || readApiKeyFile();
   for (let i = 0; i < argv.length; i++) {
     if (argv[i] === "--host" && argv[i + 1]) {
       host = argv[++i];
     } else if (argv[i] === "--api-key" && argv[i + 1]) {
       apiKey = argv[++i];
-    } else if (argv[i] === "--subdomain" && argv[i + 1]) {
-      subdomain = argv[++i];
     } else if (argv[i] === "--help" || argv[i] === "-h") {
       console.log("Usage: runlocal <port> [options]");
       console.log("");
+      console.log("  Expose localhost to the internet via runlocal.eu");
+      console.log("");
       console.log("Options:");
       console.log("  --host <url>        Server URL (default: wss://runlocal.eu)");
       console.log("  --api-key <key>     Runlater API key for stable subdomain");
-      console.log("  --subdomain <name>  Custom subdomain (Pro plan, requires --api-key)");
       console.log("  --help, -h          Show this help");
       console.log("");
-      console.log("Environment:");
-      console.log("  RUNLOCAL_HOST       Same as --host");
-      console.log("  RUNLATER_API_KEY    Same as --api-key");
+      console.log("API key (checked in order):");
+      console.log("  1. --api-key flag");
+      console.log("  2. RUNLATER_API_KEY environment variable");
+      console.log("  3. ~/.runlater/api-key file");
+      console.log("");
+      console.log("Examples:");
+      console.log("  npx runlocal 3000                        Random subdomain");
+      console.log("  npx runlocal 3000 --api-key pk_xxx       Stable subdomain");
+      console.log("");
+      console.log("A free runlater.eu account gives you a stable subdomain.");
       process.exit(0);
     } else if (!argv[i].startsWith("-")) {
       port = parseInt(argv[i], 10);
     }
   }
 
-  return { port, host, apiKey, subdomain };
+  return { port, host, apiKey };
 }
 
 function filterHeaders(headers) {
@@ -59,10 +75,9 @@ function filterHeaders(headers) {
   return filtered;
 }
 
-function buildWsUrl(host, apiKey, subdomain) {
+function buildWsUrl(host, apiKey) {
   const params = new URLSearchParams({ vsn: "2.0.0" });
   if (apiKey) params.set("api_key", apiKey);
-  if (subdomain) params.set("subdomain", subdomain);
   return `${host}/tunnel/websocket?${params.toString()}`;
 }
 
@@ -155,14 +170,13 @@ function createConnection(options) {
     host,
     port,
     apiKey,
-    subdomain,
     WebSocket,
     onTunnelCreated,
     onClose,
     log = console.log,
     logError = console.error,
   } = options;
-  const wsUrl = buildWsUrl(host, apiKey, subdomain);
+  const wsUrl = buildWsUrl(host, apiKey);
 
   let refCounter = 0;
   const nextRef = () => String(++refCounter);
@@ -208,6 +222,17 @@ function createConnection(options) {
     }
 
     if (event === "tunnel_created") {
+      const inspectUrl = payload.url.replace(/^https?:\/\/[^/]+/, (origin) => {
+        // Convert subdomain URL to main domain /inspect/ URL
+        // e.g., https://fuzzy-tiger.runlocal.eu → https://runlocal.eu/inspect/fuzzy-tiger
+        const parts = new URL(origin);
+        const hostParts = parts.hostname.split(".");
+        if (hostParts.length > 2) {
+          parts.hostname = hostParts.slice(1).join(".");
+        }
+        return `${parts.origin}/inspect/${payload.subdomain}`;
+      });
+
       log("");
       log(`  ${GREEN}${BOLD}Tunnel created!${RESET}`);
       log(`  ${CYAN}${BOLD}${payload.url}${RESET}`);
@@ -218,6 +243,7 @@ function createConnection(options) {
 
       log("");
       log(`  ${DIM}Forwarding to localhost:${port}${RESET}`);
+      log(`  ${DIM}Inspect requests at ${RESET}${CYAN}${inspectUrl}${RESET}`);
       log(`  ${DIM}Press Ctrl+C to stop${RESET}`);
 
       // Show tip for users without an API key

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runlocal",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Expose localhost to the internet via runlocal.eu",
   "bin": {
     "runlocal": "./index.js"