termbeam 1.2.4 → 1.2.6

package/README.md

@@ -15,6 +15,16 @@ I built this because I kept needing to run quick commands on my dev machine whil
 
 https://github.com/user-attachments/assets/9dd4f3d7-f017-4314-9b3a-f6a5688e3671
 
+### Mobile UI
+
+<table align="center">
+  <tr>
+    <td align="center"><img src="docs/assets/screenshots/mobile-session-hub.jpeg" alt="Session hub on mobile" width="250" /></td>
+    <td align="center"><img src="docs/assets/screenshots/mobile-session-preview.jpeg" alt="Session preview on mobile" width="250" /></td>
+    <td align="center"><img src="docs/assets/screenshots/mobile-terminal.jpeg" alt="Terminal on mobile" width="250" /></td>
+  </tr>
+</table>
+
 ## Quick Start
 
 ```bash
@@ -81,7 +91,7 @@ termbeam --persisted-tunnel
 termbeam --no-tunnel
 ```
 
-Requires the [Dev Tunnels CLI](https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started):
+If the [Dev Tunnels CLI](https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started) is not installed, TermBeam will offer to install it for you automatically. You can also install it manually:
 
 - **Windows:** `winget install Microsoft.devtunnel`
 - **macOS:** `brew install --cask devtunnel`
@@ -102,9 +112,10 @@ termbeam --host 127.0.0.1        # restrict to localhost (default: 0.0.0.0)
 | `--password <pw>`     | Set access password (also accepts `--password=<pw>`) | Auto-generated |
 | `--no-password`       | Disable password                                     | —              |
 | `--generate-password` | Auto-generate a secure password                      | On             |
-| `--tunnel`            | Create an ephemeral devtunnel URL                    | On             |
+| `--tunnel`            | Create an ephemeral devtunnel URL (private)          | On             |
 | `--no-tunnel`         | Disable tunnel (LAN-only)                            | —              |
 | `--persisted-tunnel`  | Create a reusable devtunnel URL                      | Off            |
+| `--public`            | Allow public tunnel access                           | Off            |
 | `--port <port>`       | Server port                                          | `3456`         |
 | `--host <addr>`       | Bind address                                         | `0.0.0.0`      |
 | `--log-level <level>` | Log verbosity (error/warn/info/debug)                | `info`         |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "termbeam",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "Beam your terminal to any device — mobile-optimized web terminal with multi-session support",
   "main": "src/server.js",
   "bin": {
@@ -9,8 +9,8 @@
   "scripts": {
     "start": "node bin/termbeam.js",
     "dev": "node bin/termbeam.js --generate-password",
-    "test": "node -e \"require('child_process').execFileSync(process.execPath,['--test',...require('fs').readdirSync('test').filter(f=>f.endsWith('.test.js')&&!f.startsWith('e2e-')).map(f=>'test/'+f)],{stdio:'inherit'})\"",
-    "test:coverage": "c8 --exclude=src/tunnel.js --reporter=text --reporter=lcov --reporter=json-summary --reporter=json node -e \"require('child_process').execFileSync(process.execPath,['--test','--test-reporter=spec','--test-reporter-destination=stdout',...require('fs').readdirSync('test').filter(f=>f.endsWith('.test.js')&&!f.startsWith('e2e-')).map(f=>'test/'+f)],{stdio:'inherit'})\"",
+    "test": "node -e \"require('child_process').execFileSync(process.execPath,['--test',...require('fs').readdirSync('test').filter(f=>f.endsWith('.test.js')&&!f.startsWith('e2e-')&&f!=='devtunnel-install.test.js').map(f=>'test/'+f)],{stdio:'inherit'})\"",
+    "test:coverage": "c8 --exclude=src/tunnel.js --reporter=text --reporter=lcov --reporter=json-summary --reporter=json node -e \"require('child_process').execFileSync(process.execPath,['--test','--test-reporter=spec','--test-reporter-destination=stdout',...require('fs').readdirSync('test').filter(f=>f.endsWith('.test.js')&&!f.startsWith('e2e-')&&f!=='devtunnel-install.test.js').map(f=>'test/'+f)],{stdio:'inherit'})\"",
     "prepare": "husky",
     "format": "prettier --write .",
     "lint": "node --check src/*.js bin/*.js",

package/public/sw.js

@@ -2,17 +2,17 @@ const CACHE_NAME = 'termbeam-v5';
 const SHELL_URLS = ['/', '/terminal'];
 
 self.addEventListener('install', (event) => {
-  event.waitUntil(
-    caches.open(CACHE_NAME).then((cache) => cache.addAll(SHELL_URLS))
-  );
+  event.waitUntil(caches.open(CACHE_NAME).then((cache) => cache.addAll(SHELL_URLS)));
   self.skipWaiting();
 });
 
 self.addEventListener('activate', (event) => {
   event.waitUntil(
-    caches.keys().then((keys) =>
-      Promise.all(keys.filter((k) => k !== CACHE_NAME).map((k) => caches.delete(k)))
-    )
+    caches
+      .keys()
+      .then((keys) =>
+        Promise.all(keys.filter((k) => k !== CACHE_NAME).map((k) => caches.delete(k))),
+      ),
   );
   self.clients.claim();
 });
@@ -21,11 +21,7 @@ self.addEventListener('fetch', (event) => {
   const url = new URL(event.request.url);
 
   // Don't cache WebSocket upgrades
-  if (
-    event.request.mode === 'websocket' ||
-    url.protocol === 'ws:' ||
-    url.protocol === 'wss:'
-  ) {
+  if (event.request.mode === 'websocket' || url.protocol === 'ws:' || url.protocol === 'wss:') {
     return;
   }
 
@@ -42,7 +38,7 @@ self.addEventListener('fetch', (event) => {
             }
             return response;
           });
-        })
+        }),
       );
     }
     return;
@@ -50,37 +46,43 @@ self.addEventListener('fetch', (event) => {
 
   // Network-first for API calls
   if (url.pathname.startsWith('/api/')) {
-    event.respondWith(
-      fetch(event.request).catch(() => caches.match(event.request))
-    );
+    event.respondWith(fetch(event.request).catch(() => caches.match(event.request)));
     return;
   }
 
   // Network-first for HTML pages (always get latest code)
-  if (event.request.mode === 'navigate' || event.request.headers.get('accept')?.includes('text/html')) {
+  if (
+    event.request.mode === 'navigate' ||
+    event.request.headers.get('accept')?.includes('text/html')
+  ) {
     event.respondWith(
-      fetch(event.request).then((response) => {
-        if (response.ok) {
-          const clone = response.clone();
-          caches.open(CACHE_NAME).then((cache) => cache.put(event.request, clone));
-        }
-        return response;
-      }).catch(() => caches.match(event.request))
+      fetch(event.request)
+        .then((response) => {
+          if (response.ok) {
+            const clone = response.clone();
+            caches.open(CACHE_NAME).then((cache) => cache.put(event.request, clone));
+          }
+          return response;
+        })
+        .catch(() => caches.match(event.request)),
     );
     return;
   }
 
   // Cache-first for static assets (JS, CSS, images)
   event.respondWith(
-    caches.match(event.request).then((cached) => {
-      if (cached) return cached;
-      return fetch(event.request).then((response) => {
-        if (response.ok) {
-          const clone = response.clone();
-          caches.open(CACHE_NAME).then((cache) => cache.put(event.request, clone));
-        }
-        return response;
-      });
-    }).catch(() => new Response('Offline', { status: 503, statusText: 'Service Unavailable' }))
+    caches
+      .match(event.request)
+      .then((cached) => {
+        if (cached) return cached;
+        return fetch(event.request).then((response) => {
+          if (response.ok) {
+            const clone = response.clone();
+            caches.open(CACHE_NAME).then((cache) => cache.put(event.request, clone));
+          }
+          return response;
+        });
+      })
+      .catch(() => new Response('Offline', { status: 503, statusText: 'Service Unavailable' })),
   );
 });

package/src/cli.js

@@ -15,9 +15,10 @@ Options:
   --password <pw>       Set access password (or TERMBEAM_PASSWORD env var)
   --generate-password   Auto-generate a secure password (default: auto)
   --no-password         Disable password authentication
-  --tunnel              Create a public devtunnel URL (default: on)
+  --tunnel              Create a devtunnel URL (default: on, private access)
   --no-tunnel           Disable tunnel (LAN-only mode)
   --persisted-tunnel    Create a reusable devtunnel URL (stable across restarts)
+  --public              Allow public tunnel access (default: private, owner-only)
   --port <port>         Set port (default: 3456, or PORT env var)
   --host <addr>         Bind address (default: 0.0.0.0)
   --log-level <level>   Set log verbosity: error, warn, info, debug (default: info)
@@ -26,7 +27,9 @@ Options:
 
 Defaults:
   By default, TermBeam enables tunnel + auto-generated password for secure
-  mobile access (clipboard, HTTPS). Use --no-tunnel for LAN-only mode.
+  mobile access (clipboard, HTTPS). Tunnels are private (owner-only via
+  Microsoft login). Use --public for public access, or
+  --no-tunnel for LAN-only mode.
 
 Examples:
   termbeam                          Start with tunnel + auto password
@@ -227,6 +230,7 @@ function parseArgs() {
   let useTunnel = true;
   let noTunnel = false;
   let persistedTunnel = false;
+  let anonymousTunnel = false;
   let explicitPassword = !!password;
 
   const args = process.argv.slice(2);
@@ -243,6 +247,8 @@ function parseArgs() {
     } else if (args[i] === '--persisted-tunnel') {
       useTunnel = true;
       persistedTunnel = true;
+    } else if (args[i] === '--public') {
+      anonymousTunnel = true;
     } else if (args[i].startsWith('--password=')) {
       password = args[i].split('=')[1];
       explicitPassword = true;
@@ -278,6 +284,12 @@ function parseArgs() {
   // --no-tunnel disables the default tunnel
   if (noTunnel) useTunnel = false;
 
+  // --public requires a tunnel
+  if (anonymousTunnel && !useTunnel) {
+    console.error('Error: --public requires a tunnel. Remove --no-tunnel or remove --public.');
+    process.exit(1);
+  }
+
   const shell = filteredArgs[0] || defaultShell;
   const shellArgs = filteredArgs.slice(1);
 
@@ -290,6 +302,7 @@ function parseArgs() {
     password,
     useTunnel,
     persistedTunnel,
+    anonymousTunnel,
     shell,
     shellArgs,
     cwd,

package/src/devtunnel-install.js

@@ -0,0 +1,141 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const readline = require('readline');
+const { execSync, execFileSync } = require('child_process');
+const log = require('./logger');
+
+const INSTALL_DIR = path.join(os.homedir(), 'bin');
+
+function getInstallDir() {
+  return INSTALL_DIR;
+}
+
+function getBinaryName() {
+  return process.platform === 'win32' ? 'devtunnel.exe' : 'devtunnel';
+}
+
+function promptUser(question) {
+  if (!process.stdin.isTTY) {
+    return Promise.resolve('');
+  }
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stderr });
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase());
+    });
+  });
+}
+
+const yellow = (s) => `\x1b[33m${s}\x1b[0m`;
+const cyan = (s) => `\x1b[36m${s}\x1b[0m`;
+const green = (s) => `\x1b[32m${s}\x1b[0m`;
+const bold = (s) => `\x1b[1m${s}\x1b[0m`;
+
+async function promptInstall() {
+  if (
+    process.platform !== 'darwin' &&
+    process.platform !== 'linux' &&
+    process.platform !== 'win32'
+  ) {
+    log.error(`Unsupported platform: ${process.platform}/${process.arch}`);
+    return null;
+  }
+
+  process.stderr.write('\n');
+  process.stderr.write(`  ${yellow('⚠')}  ${bold('DevTunnel CLI is not installed.')}\n`);
+  process.stderr.write(`  ${cyan('TermBeam uses tunnels by default for remote access.')}\n`);
+  process.stderr.write('\n');
+  const answer = await promptUser(`  Would you like me to install it for you? ${bold('(y/n)')} `);
+  if (answer !== 'y') {
+    log.info('Skipping DevTunnel install.');
+    return null;
+  }
+
+  return installDevtunnel();
+}
+
+async function installDevtunnel() {
+  try {
+    const platform = process.platform;
+
+    if (platform === 'darwin') {
+      log.info('Installing devtunnel via brew...');
+      execSync('brew install --cask devtunnel', { stdio: 'inherit', timeout: 120000 });
+    } else if (platform === 'linux') {
+      log.info('Installing devtunnel via official install script...');
+      execSync('curl -sL https://aka.ms/DevTunnelCliInstall | bash', {
+        stdio: 'inherit',
+        timeout: 120000,
+      });
+    } else if (platform === 'win32') {
+      log.info('Installing devtunnel via winget...');
+      execSync(
+        'winget install Microsoft.devtunnel --accept-source-agreements --accept-package-agreements',
+        {
+          stdio: 'inherit',
+          timeout: 120000,
+        },
+      );
+    }
+
+    // Find the installed binary
+    const found = findInstalledBinary();
+    if (found) {
+      log.info(`${green('✔')} DevTunnel CLI installed and verified successfully.`);
+      return found;
+    }
+
+    log.error('DevTunnel was installed but could not be found on PATH.');
+    return null;
+  } catch (err) {
+    log.error(`DevTunnel install failed: ${err.message}`);
+    return null;
+  }
+}
+
+function findInstalledBinary() {
+  // Check PATH first
+  try {
+    execSync('devtunnel --version', { stdio: 'pipe', timeout: 10000 });
+    return 'devtunnel';
+  } catch {}
+
+  // On Windows, winget modifies PATH but the current process won't see it.
+  // Use 'where' to find it via the system PATH registry.
+  if (process.platform === 'win32') {
+    try {
+      const wherePath = execSync('where devtunnel.exe', {
+        encoding: 'utf-8',
+        stdio: 'pipe',
+        timeout: 10000,
+      })
+        .trim()
+        .split(/\r?\n/)[0];
+      if (wherePath && fs.existsSync(wherePath)) return wherePath;
+    } catch {}
+
+    const candidates = [
+      path.join(process.env.LOCALAPPDATA || '', 'Microsoft', 'WinGet', 'Links', 'devtunnel.exe'),
+      path.join(process.env.LOCALAPPDATA || '', 'Microsoft', 'WindowsApps', 'devtunnel.exe'),
+      path.join(process.env.PROGRAMFILES || '', 'Microsoft', 'devtunnel', 'devtunnel.exe'),
+    ];
+    for (const p of candidates) {
+      if (fs.existsSync(p)) return p;
+    }
+  }
+
+  // Check ~/bin (where the Linux install script puts it)
+  const homeBin = path.join(os.homedir(), 'bin', getBinaryName());
+  if (fs.existsSync(homeBin)) {
+    try {
+      execFileSync(homeBin, ['--version'], { stdio: 'pipe', timeout: 10000 });
+      return homeBin;
+    } catch {}
+  }
+
+  return null;
+}
+
+module.exports = { installDevtunnel, promptInstall, getInstallDir };

package/src/logger.js

@@ -13,10 +13,11 @@ const log = {
     if (l !== undefined) currentLevel = l;
   },
   getLevel() {
-    return Object.keys(LEVELS).find(k => LEVELS[k] === currentLevel);
+    return Object.keys(LEVELS).find((k) => LEVELS[k] === currentLevel);
   },
   error(...args) {
-    if (currentLevel >= LEVELS.error) console.error(`[${timestamp()}]`, `[${LABELS.error}]`, ...args);
+    if (currentLevel >= LEVELS.error)
+      console.error(`[${timestamp()}]`, `[${LABELS.error}]`, ...args);
   },
   warn(...args) {
     if (currentLevel >= LEVELS.warn) console.warn(`[${timestamp()}]`, `[${LABELS.warn}]`, ...args);

package/src/server.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 const os = require('os');
 const path = require('path');
+const readline = require('readline');
 const express = require('express');
 const cookieParser = require('cookie-parser');
 const http = require('http');
@@ -26,6 +27,16 @@ function getLocalIP() {
   return '127.0.0.1';
 }
 
+function confirmAnonymousTunnel() {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((resolve) => {
+    rl.question('  Do you want to continue with anonymous access? (y/N): ', (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase() === 'y');
+    });
+  });
+}
+
 /**
  * Create a TermBeam server instance without starting it.
  * @param {object} [overrides] - Optional overrides
@@ -78,28 +89,47 @@ function createTermBeamServer(overrides = {}) {
     wss.close();
   }
 
-  function start() {
-    // Fail early if tunnel mode is on but devtunnel CLI is not installed
+  async function start() {
+    // If tunnel mode is on but devtunnel is missing, offer to install it
     if (config.useTunnel && !findDevtunnel()) {
-      log.error('❌ devtunnel CLI is not installed.');
-      log.error('');
-      log.error('  TermBeam uses tunnels by default for remote access.');
-      log.error('  Install the Azure Dev Tunnels CLI, or use --no-tunnel for LAN-only mode.');
-      log.error('');
-      log.error('  Install it:');
-      log.error('    Windows:  winget install Microsoft.devtunnel');
-      log.error(
-        '             or: Invoke-WebRequest -Uri https://aka.ms/TunnelsCliDownload/win-x64 -OutFile devtunnel.exe',
-      );
-      log.error('    macOS:    brew install --cask devtunnel');
-      log.error('    Linux:    curl -sL https://aka.ms/DevTunnelCliInstall | bash');
-      log.error('');
-      log.error('  Then restart your terminal and try again.');
-      log.error(
-        '  Docs: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started',
-      );
-      log.error('');
-      process.exit(1);
+      const { promptInstall } = require('./devtunnel-install');
+      const installed = await promptInstall();
+      if (!installed) {
+        log.error('❌ DevTunnel CLI is not available.');
+        log.error('');
+        log.error('  Use --no-tunnel for LAN-only mode, or install manually:');
+        log.error('    Windows:  winget install Microsoft.devtunnel');
+        log.error('    macOS:    brew install --cask devtunnel');
+        log.error('    Linux:    curl -sL https://aka.ms/DevTunnelCliInstall | bash');
+        log.error('');
+        log.error(
+          '  Docs: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started',
+        );
+        log.error('');
+        process.exit(1);
+      }
+    }
+
+    // Warn and require consent for anonymous tunnel access
+    if (config.useTunnel && config.anonymousTunnel) {
+      const rd = '\x1b[31m';
+      const yl = '\x1b[33m';
+      const rs = '\x1b[0m';
+      const bd = '\x1b[1m';
+      console.log('');
+      console.log(`  ${rd}${bd}⚠️  DANGER: Public tunnel access requested${rs}`);
+      console.log('');
+      console.log(`  ${yl}This will make your terminal accessible to ANYONE with the URL.${rs}`);
+      console.log(`  ${yl}No Microsoft login will be required to reach the tunnel.${rs}`);
+      console.log(`  ${yl}Only the TermBeam password will protect your terminal.${rs}`);
+      console.log('');
+      const confirmed = await confirmAnonymousTunnel();
+      if (!confirmed) {
+        console.log('');
+        console.log('  Aborted. Restart without --public for private access.');
+        console.log('');
+        process.exit(1);
+      }
     }
 
     return new Promise((resolve) => {
@@ -146,7 +176,10 @@ function createTermBeamServer(overrides = {}) {
 
         let publicUrl = null;
         if (config.useTunnel) {
-          const tunnel = await startTunnel(config.port, { persisted: config.persistedTunnel });
+          const tunnel = await startTunnel(config.port, {
+            persisted: config.persistedTunnel,
+            anonymous: config.anonymousTunnel,
+          });
           if (tunnel) {
             publicUrl = tunnel.url;
             state.shareBaseUrl = publicUrl;

package/src/sessions.js

@@ -3,8 +3,14 @@ const pty = require('node-pty');
 const log = require('./logger');
 
 const SESSION_COLORS = [
-  '#4a9eff', '#4ade80', '#fbbf24', '#c084fc',
-  '#f87171', '#22d3ee', '#fb923c', '#f472b6',
+  '#4a9eff',
+  '#4ade80',
+  '#fbbf24',
+  '#c084fc',
+  '#f87171',
+  '#22d3ee',
+  '#fb923c',
+  '#f472b6',
 ];
 
 class SessionManager {

package/src/tunnel.js

@@ -3,6 +3,7 @@ const path = require('path');
 const fs = require('fs');
 const os = require('os');
 const log = require('./logger');
+const { promptInstall } = require('./devtunnel-install');
 
 const TUNNEL_CONFIG_DIR = path.join(os.homedir(), '.termbeam');
 const TUNNEL_CONFIG_PATH = path.join(TUNNEL_CONFIG_DIR, 'tunnel.json');
@@ -33,6 +34,19 @@ function findDevtunnel() {
     }
   }
 
+  // Check ~/bin (where the Linux install script places it)
+  const homeBin = path.join(
+    os.homedir(),
+    'bin',
+    process.platform === 'win32' ? 'devtunnel.exe' : 'devtunnel',
+  );
+  if (fs.existsSync(homeBin)) {
+    try {
+      execFileSync(homeBin, ['--version'], { stdio: 'pipe' });
+      return homeBin;
+    } catch {}
+  }
+
   return null;
 }
 
@@ -85,22 +99,18 @@ let isPersisted = false;
 
 async function startTunnel(port, options = {}) {
   // Check if devtunnel CLI is installed
-  const found = findDevtunnel();
+  let found = findDevtunnel();
   if (!found) {
-    log.error('❌ devtunnel CLI is not installed.');
-    log.error('');
-    log.error('  TermBeam uses tunnels by default for remote access.');
-    log.error('  Install the Azure Dev Tunnels CLI, or use --no-tunnel for LAN-only mode.');
+    found = await promptInstall();
+  }
+  if (!found) {
+    log.error('❌ DevTunnel CLI is not available.');
     log.error('');
-    log.error('  Install it:');
+    log.error('  Use --no-tunnel for LAN-only mode, or install manually:');
     log.error('    Windows:  winget install Microsoft.devtunnel');
-    log.error(
-      '             or: Invoke-WebRequest -Uri https://aka.ms/TunnelsCliDownload/win-x64 -OutFile devtunnel.exe',
-    );
     log.error('    macOS:    brew install --cask devtunnel');
     log.error('    Linux:    curl -sL https://aka.ms/DevTunnelCliInstall | bash');
     log.error('');
-    log.error('  Then restart your terminal and try again.');
     log.error('  Docs: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started');
     log.error('');
     return null;
@@ -186,13 +196,25 @@ async function startTunnel(port, options = {}) {
         { stdio: 'pipe' },
       );
     } catch {}
-    try {
-      execFileSync(
-        devtunnelCmd,
-        ['access', 'create', tunnelId, '-p', String(port), '--anonymous'],
-        { stdio: 'pipe' },
-      );
-    } catch {}
+    // Set tunnel access: public (anonymous) or private (owner-only via Microsoft login)
+    if (options.anonymous) {
+      try {
+        execFileSync(
+          devtunnelCmd,
+          ['access', 'create', tunnelId, '-p', String(port), '--anonymous'],
+          { stdio: 'pipe' },
+        );
+      } catch {}
+      log.info('Tunnel access: public (anonymous)');
+    } else {
+      // Remove any existing anonymous access to ensure the tunnel is private
+      try {
+        execFileSync(devtunnelCmd, ['access', 'reset', tunnelId], {
+          stdio: 'pipe',
+        });
+      } catch {}
+      log.info('Tunnel access: private (owner-only via Microsoft login)');
+    }
 
     const hostProc = spawn(devtunnelCmd, ['host', tunnelId], {
       stdio: ['pipe', 'pipe', 'pipe'],