runlocal 0.5.1 → 0.7.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 } = parseArgs(process.argv.slice(2));
+const { port, host, apiKey, subdomain } = parseArgs(process.argv.slice(2));
 
 console.log(`${BOLD}runlocal${RESET} — expose localhost:${port} to the internet`);
-createConnection({ host, port, apiKey, WebSocket });
+createConnection({ host, port, apiKey, subdomain, WebSocket });

package/lib.js

@@ -29,38 +29,45 @@ function parseArgs(argv) {
   let port = 3000;
   let host = process.env.RUNLOCAL_HOST || "wss://runlocal.eu";
   let apiKey = process.env.RUNLATER_API_KEY || readApiKeyFile();
+  let subdomain = null;
   for (let i = 0; i < argv.length; i++) {
-    if (argv[i] === "--host" && argv[i + 1]) {
+    if ((argv[i] === "--server" || 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("  Expose localhost to the internet. Works with runlocal.eu");
+      console.log("  or any self-hosted runlocal server.");
       console.log("");
       console.log("Options:");
-      console.log("  --host <url>        Server URL (default: wss://runlocal.eu)");
+      console.log("  --server <url>      Server URL (default: wss://runlocal.eu)");
       console.log("  --api-key <key>     Runlater API key for stable subdomain");
+      console.log("  --subdomain <name>  Request a specific subdomain");
       console.log("  --help, -h          Show this help");
       console.log("");
-      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("Environment variables:");
+      console.log("  RUNLOCAL_HOST       Server URL (same as --server)");
+      console.log("  RUNLATER_API_KEY    API key (same as --api-key)");
       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("  npx runlocal 3000                              Random subdomain");
+      console.log("  npx runlocal 3000 --api-key pk_xxx             Stable subdomain");
+      console.log("  npx runlocal 3000 --subdomain my-api           Custom subdomain");
+      console.log("  npx runlocal 3000 --server wss://tunnel.example.com  Self-hosted");
       console.log("");
-      console.log("A free runlater.eu account gives you a stable subdomain.");
+      console.log("Self-hosting: https://github.com/runlater-eu/runlocal");
+      console.log("Hosted version: https://runlocal.eu");
       process.exit(0);
     } else if (!argv[i].startsWith("-")) {
       port = parseInt(argv[i], 10);
     }
   }
 
-  return { port, host, apiKey };
+  return { port, host, apiKey, subdomain };
 }
 
 function filterHeaders(headers) {
@@ -75,9 +82,10 @@ function filterHeaders(headers) {
   return filtered;
 }
 
-function buildWsUrl(host, apiKey) {
+function buildWsUrl(host, apiKey, subdomain) {
   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()}`;
 }
 
@@ -170,13 +178,14 @@ function createConnection(options) {
     host,
     port,
     apiKey,
+    subdomain,
     WebSocket,
     onTunnelCreated,
     onClose,
     log = console.log,
     logError = console.error,
   } = options;
-  const wsUrl = buildWsUrl(host, apiKey);
+  const wsUrl = buildWsUrl(host, apiKey, subdomain);
 
   let refCounter = 0;
   const nextRef = () => String(++refCounter);

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "runlocal",
-  "version": "0.5.1",
-  "description": "Expose localhost to the internet via runlocal.eu",
+  "version": "0.7.0",
+  "description": "Expose localhost to the internet — open source tunnel server",
   "bin": {
     "runlocal": "./index.js"
   },
-  "files": ["index.js", "lib.js"],
+  "files": [
+    "index.js",
+    "lib.js"
+  ],
   "scripts": {
     "test": "node --test test/*.test.js"
   },
-  "keywords": ["tunnel", "localhost", "ngrok", "dev", "https"],
+  "keywords": [
+    "tunnel",
+    "localhost",
+    "ngrok",
+    "dev",
+    "https"
+  ],
   "license": "MIT",
   "dependencies": {
     "ws": "^8.0.0"