Remove Postbox shortcut

Author: dasomji

README.md

@@ -6,12 +6,6 @@ Lizardtail is a Tailscale Serve wrapper around other commands. It runs a command
 lizardtail pnpm dev
 ```
 
-For Pi Postbox, use the built-in shortcut:
-
-```bash
-lizardtail postbox
-```
-
 ```text
 Local: http://localhost:5173
 
@@ -24,7 +18,6 @@ Use it when your dev server is running on a remote machine and you want to open
 ## Features
 
 - Runs any command you pass it, such as `pnpm dev`, `npm run dev`, `bun run dev`, or `python -m http.server`.
-- Supports `lizardtail postbox` as a shortcut that launches `pi-postbox-server`, detects its actual printed local port, and exposes that port.
 - Streams the child command's stdout/stderr normally.
 - Detects common dev-server output formats, including `http://localhost:5173`, `http://127.0.0.1:3000`, `started server on 0.0.0.0:8080`, and `PORT=4321`.
 - Ignores timing output like `ready in 500 ms` so it does not accidentally expose port `500`.
@@ -45,7 +38,6 @@ Use it when your dev server is running on a remote machine and you want to open
 
 - Node.js 20 or newer.
 - Tailscale installed and available as `tailscale` on `PATH`.
-- For `lizardtail postbox`, `pi-postbox-server` must also be installed or linked on `PATH`.
 - The device must be logged into Tailscale.
 - Tailscale Serve must be available for the device/tailnet.
 - For `--public`, Tailscale Funnel must be enabled for the device/tailnet.
@@ -110,7 +102,6 @@ node dist/index.js pnpm dev
 ```bash
 lizardtail [options] -- <command> [args...]
 lizardtail [options] <command> [args...]
-lizardtail postbox [pi-postbox-server args...]
 lizardtail help [topic]
 lizardtail config init
 ```
@@ -145,25 +136,16 @@ These commands are meant for both humans and coding agents: they describe usage,
 
 ## Examples
 
-### Pi Postbox
-
-```bash
-lizardtail postbox
-```
-
-This starts `pi-postbox-server` with `--host 127.0.0.1` and preferred `--port 3000`, passes any extra arguments after `postbox` through to `pi-postbox-server`, waits for the server's printed listening URL, and exposes the detected actual port privately to your tailnet. If Postbox falls back because port `3000` is busy, lizardtail exposes the fallback port.
+### Vite / frontend dev server
 
 ```bash
-lizardtail postbox --database ~/.pi-postbox/postbox.sqlite
-lizardtail --public postbox
+lizardtail pnpm dev
 ```
 
-With this shortcut, `lizardtail --port 3333 postbox` passes `3333` as Postbox's preferred local port and still detects the actual port before exposing.
-
-### Vite / frontend dev server
+If the frontend dev server proxies API requests to a backend, expose the frontend port so the proxied backend remains reachable from the remote browser:
 
 ```bash
-lizardtail pnpm dev
+lizardtail --port 5173 npm run dev
 ```
 
 If Vite is configured to bind to another host:

src/index.ts

@@ -73,8 +73,8 @@ Options:
   -h, --help           Show this help.
 
 Examples:
-  lizardtail postbox
   lizardtail pnpm dev
+  lizardtail --port 5173 npm run dev
   lizardtail --port 3000 npm run dev
   lizardtail --tailscale-port 8450 pnpm dev
   lizardtail --public pnpm dev
@@ -112,12 +112,16 @@ If a config file exists, its blockedPorts list replaces the built-in default lis
 Run a dev server command, detect its local port, and expose it through Tailscale.
 
 Common usage:
-  lizardtail postbox
   lizardtail pnpm dev
+  lizardtail --port 5173 npm run dev
   lizardtail --port 3000 npm run dev
   lizardtail --tailscale-port 8450 pnpm dev
   lizardtail --public pnpm dev
 
+For an app whose frontend dev server proxies to a backend (e.g. a Vite SPA proxying
+/api), expose the frontend port with --port so its proxied backend is reachable too:
+  lizardtail --port 5173 npm run dev
+
 Private vs public:
   Default: private tailnet-only Tailscale Serve.
   --public / --funnel: public internet exposure through Tailscale Funnel.
@@ -131,9 +135,6 @@ Safety:
 Help topics:
   lizardtail help config
 
-Postbox shortcut:
-  lizardtail postbox          Run pi-postbox-server with local defaults, detect its actual port, and expose it.
-
 Other commands:
   lizardtail config init      Write a starter config file.
 `);
@@ -287,25 +288,6 @@ export function parseArgs(argv: string[]): Options {
   return options;
 }
 
-function commandArgsIncludeOption(args: string[], name: string): boolean {
-  return args.some((arg) => arg === name || arg.startsWith(`${name}=`));
-}
-
-export function applyPostboxAlias(options: Options): Options {
-  if (options.command[0] !== "postbox") return options;
-
-  const extraArgs = options.command.slice(1);
-  const postboxArgs: string[] = [];
-  if (!commandArgsIncludeOption(extraArgs, "--host")) postboxArgs.push("--host", options.host);
-  if (!commandArgsIncludeOption(extraArgs, "--port")) postboxArgs.push("--port", String(options.port ?? 3000));
-
-  const { port: _preferredPostboxPort, ...detectionOptions } = options;
-  return {
-    ...detectionOptions,
-    command: ["pi-postbox-server", ...postboxArgs, ...extraArgs],
-  };
-}
-
 function parsePort(value: string): number {
   const port = Number(value);
   if (!Number.isInteger(port) || port < 1 || port > 65_535) {
@@ -767,9 +749,7 @@ export async function main(): Promise<void> {
   const argv = process.argv.slice(2);
   if (await handleMetaCommand(argv)) return;
 
-  const parsedOptions = parseArgs(argv);
-  const postboxAlias = parsedOptions.command[0] === "postbox";
-  const options = applyPostboxAlias(parsedOptions);
+  const options = parseArgs(argv);
   const config = await loadConfig();
   const [command, ...args] = options.command;
   const tailscaleDnsName = await getTailscaleDnsName().catch(() => undefined);
@@ -899,8 +879,8 @@ export async function main(): Promise<void> {
   });
 
   child.on("error", (error) => {
-    if (postboxAlias && (error as NodeJS.ErrnoException).code === "ENOENT") {
-      console.error("lizardtail: failed to start pi-postbox-server: not found on PATH. Install or link @pi-postbox/server so the pi-postbox-server binary is available.");
+    if ((error as NodeJS.ErrnoException).code === "ENOENT") {
+      console.error(`lizardtail: failed to start ${command}: command not found on PATH.`);
     } else {
       console.error(`lizardtail: failed to start ${command}: ${error.message}`);
     }

tests/index.test.ts

@@ -6,7 +6,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { test } from "node:test";
 
-import { DEFAULT_TIMEOUT_MS, applyPostboxAlias, detectLaravelViteServers, detectPortFromText, exposeWithTailscale, parseArgs, stripAnsi } from "../src/index.ts";
+import { DEFAULT_TIMEOUT_MS, detectLaravelViteServers, detectPortFromText, exposeWithTailscale, parseArgs, stripAnsi } from "../src/index.ts";
 
 const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
 const cliPath = path.join(repoRoot, "dist", "index.js");
@@ -45,7 +45,7 @@ test("detectPortFromText ignores invalid ports, missing ports, build durations,
   assert.equal(detectPortFromText("VITE v8.0.13 ready in 500 ms"), undefined);
   assert.equal(detectPortFromText("port 3000 is already in use"), undefined);
   assert.equal(detectPortFromText("Error: listen EADDRINUSE: address already in use http://127.0.0.1:3000"), undefined);
-  assert.equal(detectPortFromText("port 3000 is already in use\npi-postbox-server listening on http://127.0.0.1:3001"), 3001);
+  assert.equal(detectPortFromText("port 3000 is already in use\nmy-server listening on http://127.0.0.1:3001"), 3001);
 });
 
 // Laravel's `composer run dev` commonly runs Vite and `php artisan serve` together.
@@ -102,34 +102,6 @@ test("parseArgs uses documented defaults", () => {
   });
 });
 
-test("applyPostboxAlias expands lizardtail postbox to pi-postbox-server defaults and keeps detection enabled", () => {
-  assert.deepEqual(applyPostboxAlias(parseArgs(["--port", "3333", "postbox", "--database", ":memory:"])), {
-    command: ["pi-postbox-server", "--host", "127.0.0.1", "--port", "3333", "--database", ":memory:"],
-    host: "127.0.0.1",
-    timeoutMs: DEFAULT_TIMEOUT_MS,
-    openCheck: true,
-    public: false,
-  });
-});
-
-test("applyPostboxAlias preserves explicit Postbox host and port overrides", () => {
-  assert.deepEqual(applyPostboxAlias(parseArgs(["postbox", "--port", "3333", "--host=localhost"])), {
-    command: ["pi-postbox-server", "--port", "3333", "--host=localhost"],
-    host: "127.0.0.1",
-    timeoutMs: DEFAULT_TIMEOUT_MS,
-    openCheck: true,
-    public: false,
-  });
-
-  assert.deepEqual(applyPostboxAlias(parseArgs(["postbox", "--port=4444", "--host", "localhost"])), {
-    command: ["pi-postbox-server", "--port=4444", "--host", "localhost"],
-    host: "127.0.0.1",
-    timeoutMs: DEFAULT_TIMEOUT_MS,
-    openCheck: true,
-    public: false,
-  });
-});
-
 test("parseArgs supports explicit Tailscale HTTPS ports", () => {
   assert.deepEqual(parseArgs(["--tailscale-port", "8450", "--vite-tailscale-port", "8453", "pnpm", "dev"]), {
     command: ["pnpm", "dev"],
@@ -172,28 +144,10 @@ test("CLI help command prints detailed documentation", async () => {
   assert.match(stdout, /lizardtail config init/);
 });
 
-test("CLI help documents the Postbox shortcut", async () => {
-  const child = spawn(process.execPath, [cliPath, "help"], {
-    cwd: repoRoot,
-    stdio: ["ignore", "pipe", "pipe"],
-  });
-
-  let stdout = "";
-  child.stdout.setEncoding("utf8");
-  child.stdout.on("data", (chunk: string) => {
-    stdout += chunk;
-  });
-
-  const exitCode = await new Promise<number | null>((resolve) => child.on("exit", resolve));
-
-  assert.equal(exitCode, 0);
-  assert.match(stdout, /lizardtail postbox/);
-});
-
-test("CLI prints an actionable error when the Postbox binary is missing", async () => {
+test("CLI prints an actionable error when the command is missing from PATH", async () => {
   const tempDir = await mkdtemp(path.join(tmpdir(), "lizardtail-test-"));
   try {
-    const child = spawn(process.execPath, [cliPath, "postbox"], {
+    const child = spawn(process.execPath, [cliPath, "definitely-not-a-real-command"], {
       cwd: repoRoot,
       env: { ...process.env, PATH: tempDir },
       stdio: ["ignore", "pipe", "pipe"],
@@ -208,7 +162,7 @@ test("CLI prints an actionable error when the Postbox binary is missing", async
     const exitCode = await new Promise<number | null>((resolve) => child.on("exit", resolve));
 
     assert.equal(exitCode, 1);
-    assert.match(stderr, /failed to start pi-postbox-server: not found on PATH/);
+    assert.match(stderr, /failed to start definitely-not-a-real-command: command not found on PATH/);
   } finally {
     await rm(tempDir, { recursive: true, force: true });
   }
@@ -615,86 +569,3 @@ server.listen(0, "127.0.0.1", () => {
   }
 });
 
-test("CLI postbox shortcut starts pi-postbox-server and exposes its detected port", async () => {
-  const tempDir = await mkdtemp(path.join(tmpdir(), "lizardtail-postbox-test-"));
-  await writeHostCommandStubs(tempDir);
-  const tailscalePath = path.join(tempDir, "tailscale");
-  const tailscaleLog = path.join(tempDir, "tailscale.log");
-  const postboxPath = path.join(tempDir, "pi-postbox-server");
-  const postboxLog = path.join(tempDir, "postbox.log");
-
-  await writeFile(
-    tailscalePath,
-    `#!/usr/bin/env bash
-printf '%s\n' "$*" >> "$TAILSCALE_LOG"
-if [ "$1" = "status" ] && [ "$2" = "--json" ]; then
-  echo '{"Self":{"DNSName":"test-host.tailnet.ts.net.","TailscaleIPs":["100.64.0.1"]}}'
-  exit 0
-fi
-if [ "$1" = "status" ]; then
-  echo 'ok'
-  exit 0
-fi
-if [ "$1" = "serve" ]; then
-  echo 'serve ok'
-  exit 0
-fi
-exit 1
-`,
-    { mode: 0o755 },
-  );
-
-  await writeFile(
-    postboxPath,
-    `#!/usr/bin/env bash
-printf '%s\n' "$*" >> "$POSTBOX_LOG"
-node -e 'const http = require("http");
-const server = http.createServer((req, res) => res.end("ok"));
-server.listen(0, "127.0.0.1", () => {
-  console.log("pi-postbox-server listening on http://127.0.0.1:" + server.address().port);
-  setTimeout(() => server.close(), 2500);
-});'
-`,
-    { mode: 0o755 },
-  );
-
-  try {
-    const child = spawn(process.execPath, [cliPath, "--timeout", "5000", "postbox", "--database", ":memory:"], {
-      cwd: repoRoot,
-      env: {
-        ...process.env,
-        PATH: `${tempDir}${path.delimiter}${process.env.PATH ?? ""}`,
-        TAILSCALE_LOG: tailscaleLog,
-        POSTBOX_LOG: postboxLog,
-      },
-      stdio: ["ignore", "pipe", "pipe"],
-    });
-
-    let stdout = "";
-    let stderr = "";
-    child.stdout.setEncoding("utf8");
-    child.stderr.setEncoding("utf8");
-    child.stdout.on("data", (chunk: string) => {
-      stdout += chunk;
-    });
-    child.stderr.on("data", (chunk: string) => {
-      stderr += chunk;
-    });
-
-    const exitCode = await new Promise<number | null>((resolve) => child.on("exit", resolve));
-
-    assert.equal(exitCode, 0, `stdout:\n${stdout}\nstderr:\n${stderr}`);
-    assert.match(stdout, /pi-postbox-server listening on http:\/\/127\.0\.0\.1:\d+/);
-    assert.match(stderr, /lizardtail: detected local server on http:\/\/127\.0\.0\.1:\d+/);
-    assert.match(stderr, /lizardtail: serving via Tailscale: https:\/\/test-host\.tailnet\.ts\.net/);
-
-    const postboxCall = await readFile(postboxLog, "utf8");
-    assert.match(postboxCall, /--host 127\.0\.0\.1 --port 3000 --database :memory:/);
-
-    const tailscaleCalls = await readFile(tailscaleLog, "utf8");
-    assert.match(tailscaleCalls, /serve --bg --https 8443 http:\/\/127\.0\.0\.1:\d+/);
-    assert.match(tailscaleCalls, /serve --https=8443 off/);
-  } finally {
-    await rm(tempDir, { recursive: true, force: true });
-  }
-});