@hamedb89/localghost 0.1.9 → 0.1.10

package/README.md

@@ -9,46 +9,18 @@ Buh. Friendly local hostnames for app repos.
 [![CI](https://github.com/hamedb89/localghost/actions/workflows/ci.yml/badge.svg)](https://github.com/hamedb89/localghost/actions/workflows/ci.yml)
 [![GitHub Pages](https://github.com/hamedb89/localghost/actions/workflows/pages.yml/badge.svg)](https://github.com/hamedb89/localghost/actions/workflows/pages.yml)
 [![Publish npm](https://github.com/hamedb89/localghost/actions/workflows/publish-npm.yml/badge.svg)](https://github.com/hamedb89/localghost/actions/workflows/publish-npm.yml)
-[![npm version](https://img.shields.io/badge/npm-v0.1.9-CB3837?logo=npm)](https://www.npmjs.com/package/@hamedb89/localghost)
+[![npm version](https://img.shields.io/badge/npm-v0.1.10-CB3837?logo=npm)](https://www.npmjs.com/package/@hamedb89/localghost)
 
-Localghost is a tiny Node.js CLI for friendly local domains in app repos. Add it as a dev dependency, run `yarn dev`, and use `http://app.localhost/` instead of remembering which localhost port belongs to which process.
+Localghost is a tiny Node.js CLI for clean local app domains. Add it as a dev dependency, keep running the command your team already knows, and use `http://app.localhost/` instead of remembering which port belongs to which process.
 
-[Website](https://hamedb89.github.io/localghost/) · [npm](https://www.npmjs.com/package/@hamedb89/localghost) · [GitHub](https://github.com/hamedb89/localghost)
+[Website](https://hamedb89.github.io/localghost/) · [Docs](https://hamedb89.github.io/localghost/docs/) · [npm](https://www.npmjs.com/package/@hamedb89/localghost) · [GitHub](https://github.com/hamedb89/localghost)
 
-## What It Does
-
-- Creates and reads `.localghost` in your app repo.
-- Lets repos choose explicit config files or filename patterns when `.localghost` is not enough.
-- Updates only a managed Localghost block in `/etc/hosts` during explicit setup.
-- Generates `ops/local/Caddyfile` for local reverse proxying. HTTP is the default; HTTPS is explicit with `--https` or `--ssl`.
-- Checks whether Caddy is installed, but does not run Homebrew for you.
-- Provides a Vite plugin that sets explicit `server.allowedHosts` entries.
-- Defaults Vite dev to the configured Localghost domain and no-ops during production/build.
-- Prints parsed config and project-local state as JSON for scripts, Codex, agents, and future MCP tools.
-- Checks npm for newer Localghost releases at most once per day, with an explicit opt-out.
-
-## Trust
-
-- CI runs typecheck, build, site build, and npm package dry-run on Node 20 and 22.
-- GitHub Pages is deployed by Actions from the checked-in `site/` and `assets/` sources.
-- Preview the exact Pages artifact locally with `npm run site:serve`, then open `http://127.0.0.1:4173/`.
-- npm publish is guarded by `prepublishOnly` and the release workflow publishes with npm provenance.
-- Runtime dependencies are intentionally small: `commander` for the CLI and `execa` for process execution. Vite is an optional peer dependency for the Vite plugin.
-- No postinstall scripts, hidden Homebrew installs, or broad hosts-file rewrites.
-- Update checks are best-effort, cached for 24 hours, and can be disabled with `LOCALGHOST_NO_UPDATE_CHECK=1` or `--no-update-check`.
-
-<p align="center">
-  <img src="./assets/localghost-app-icon.png" alt="Localghost app icon" width="180">
-</p>
-
-## Start Here
+## Quick Start
 
 ```sh
 yarn add -D @hamedb89/localghost
 ```
 
-That is the entrypoint you are optimizing for: install the dev dependency, keep using the dev command your team already knows, and let Localghost handle the local-domain setup around it.
-
 For Vite apps, add the plugin once:
 
 ```ts
@@ -60,15 +32,13 @@ export default defineConfig({
 });
 ```
 
-Now your daily command is just:
+Then keep using the command your repo already expects:
 
 ```sh
 yarn dev
 ```
 
-And you are ready.
-
-On the first interactive `yarn dev`, Localghost can create `.localghost`, explain the `/etc/hosts` change, write the local Caddyfile, and then print the browser-facing URL:
+On the first interactive run, Localghost can create `.localghost`, explain the `/etc/hosts` change, write `ops/local/Caddyfile`, and print the browser-facing URL:
 
 ```txt
 localghost
@@ -77,7 +47,7 @@ also:   http://www.app.localhost/
 target: http://127.0.0.1:5173/
 ```
 
-If your project does not use Vite, or you want one command that starts Caddy and then your app process, wrap your raw dev script:
+For non-Vite apps, wrap your raw dev command:
 
 ```json
 {
@@ -88,413 +58,67 @@ If your project does not use Vite, or you want one command that starts Caddy and
 }
 ```
 
-Then the daily command stays the same:
-
-```sh
-yarn dev
-```
-
-## Configuration
-
-Most apps only need a `.localghost` file when they want explicit hostnames or multiple services:
-
-```txt
-# Buh. Friendly names for local services.
-# Format: <host> <port>
-app.localhost 5173
-www.app.localhost 5173
-api.app.localhost 8787
-```
-
-If `.localghost` is missing, the Vite plugin can prompt to create it during `yarn dev`. You can also create it directly:
-
-```sh
-yarn localghost init
-```
-
-Check the machine:
-
-```sh
-yarn localghost doctor
-```
-
-If Caddy is missing, Localghost prints:
-
-```txt
-Caddy: missing
-Run: brew install caddy
-Localghost will not install it for you. No surprise spells.
-```
-
-Prepare or repair the machine setup directly:
-
-```sh
-yarn localghost setup
-```
-
-Check that the hosts block and Caddyfile are ready:
-
-```sh
-yarn localghost status --ready
-```
-
-Run only the proxy when your app server is started separately:
-
-```sh
-yarn localghost dev
-```
-
-Use HTTPS only when you explicitly want Caddy local certificates:
-
-```sh
-yarn localghost dev --https
-```
-
-Trust Caddy's local HTTPS CA when you want browsers to stop showing local certificate warnings:
-
-```sh
-yarn localghost trust
-```
-
-Reset generated setup without deleting `.localghost`:
-
-```sh
-yarn localghost reset
-yarn localghost setup
-```
-
-Prefer `.localhost` names. `.local` is supported, but Localghost warns because `.local` can collide with mDNS/Bonjour.
-
-## Config Files
-
-By default, Localghost reads `.localghost` from the project root. Repos that need another name can be explicit:
-
-```sh
-localghost print --config .localghost.preview
-localghost setup --config .localghost.preview
-```
-
-You can pass `--config` more than once. Localghost uses the first file that exists:
-
-```sh
-localghost print --config .localghost.private --config .localghost
-```
-
-You can also search project-root filenames with a regular expression:
-
-```sh
-localghost print --config-pattern '^\.localghost\.(private|preview)$'
-```
-
-The Vite plugin accepts the same shape through `fileName`, `configFiles`, or `configPattern`. If you run `localghost init --config .localghost.preview --write-scripts`, generated package scripts include the matching `--config` flag.
-
-## Package Scripts
-
-`localghost init --write-scripts` adds these scripts when they are missing:
-
-```json
-{
-  "scripts": {
-    "localghost:setup": "localghost setup",
-    "localghost:proxy": "localghost dev",
-    "localghost:proxy:https": "localghost dev --https",
-    "localghost:run": "localghost run --",
-    "localghost:ready": "localghost status --ready",
-    "localghost:trust": "localghost trust",
-    "localghost:ps": "localghost ps",
-    "localghost:print": "localghost print",
-    "localghost:routes": "localghost routes",
-    "localghost:status": "localghost status",
-    "localghost:reset": "localghost reset",
-    "localghost:teardown": "localghost teardown",
-    "localghost:doctor": "localghost doctor",
-    "localghost:update": "localghost update",
-    "caddy:setup": "localghost setup",
-    "caddy:dev": "localghost dev"
-  }
-}
-```
-
-A full app might compose them with its own servers:
-
-```json
-{
-  "scripts": {
-    "dev": "localghost run -- yarn dev:raw",
-    "dev:raw": "vite"
-  }
-}
-```
-
-In Turborepo, let Localghost wrap the dev runner and keep dev uncached:
-
-```json
-{
-  "scripts": {
-    "dev": "localghost run -- yarn dev:raw",
-    "dev:raw": "turbo dev"
-  }
-}
-```
-
-Then keep persistent dev tasks uncached:
-
-```json
-{
-  "tasks": {
-    "dev": { "cache": false, "persistent": true }
-  }
-}
-```
-
-`localghost run` resolves one shared Localghost context, starts Caddy, handles the optional HTTPS trust prompt, then starts the child command. That keeps Localghost setup/proxy output before Vite's ready log. It passes the selected port to the child command through `LOCALGHOST_PORT` and `VITE_PORT`, and stops Caddy when the child exits. Dynamic ports are on by default: Localghost starts at the configured port, checks `127.0.0.1:<port>`, and walks upward until it finds a free port. Use `--dynamic-port=no` when you want strict fixed-port behavior.
-
-Most repos do not need `localghost.config.mjs`. Localghost derives `project` from `package.json`, defaults to port `5173`, keeps HTTPS off by default, enables dynamic ports by default, and adds `www.` aliases by default. Add `localghost.config.mjs` only when you want to override those defaults:
-
-```js
-import { defineLocalghostConfig } from "@hamedb89/localghost";
-
-export default defineLocalghostConfig({
-  https: true
-});
-```
-
-Then the daily script can stay small:
-
-```json
-{
-  "scripts": {
-    "dev": "localghost run -- yarn dev:raw",
-    "dev:raw": "vite"
-  }
-}
-```
-
-`www.` aliases are enabled by default. A `.localghost` entry like `app.localhost 5173` also sets up `www.app.localhost` unless `wwwAlias: false` is set in `localghost.config.mjs`.
-
-`ghostTunnel` is the production opt-in for a wildcard product entrypoint on top of your deployed Vite app. The default namespace is `<route>-<project>-<owner>.ghost.<domain>`, and omitted domains are shown as `*` in logs:
-
-```js
-import { defineLocalghostConfig } from "@hamedb89/localghost";
-
-export default defineLocalghostConfig({
-  ghostTunnel: {
-    domains: "socialworkouts.app",
-    mode: "manual"
-  }
-});
-```
-
-With `ghostTunnel: { domains }`, local route and Vite startup logs use local defaults for `route`, `project`, and `owner`, then fill the configured domain:
-
-```txt
-localghost ghost tunnel
-  mode: manual
-  expected: https://app-decision-layer-hamed.ghost.socialworkouts.app/
-```
-
-Without `domains`, the expected URL stays wildcarded:
-
-```txt
-localghost ghost tunnel
-  mode: manual
-  expected: https://app-decision-layer-hamed.ghost.*/
-```
-
-`ghostTunnel: "manual"` and `ghostTunnel: "public"` are shorthand modes. `manual` is the default; use `enabled: false` to keep domains/config in the file without exposing the tunnel surface.
-
-Use object form to override defaults or provide a concrete preview URL:
-
-```js
-export default defineLocalghostConfig({
-  ghostTunnel: {
-    domains: "socialworkouts.app",
-    preview: {
-      route: "plan",
-      project: "summer-base",
-      owner: "hamed"
-    }
-  }
-});
-```
-
-Production apps can read that flag without requiring the local `.localghost` file, then construct and validate tunnel URLs:
-
-```ts
-import {
-  assertSecureGhostTunnelRequest,
-  constructGhostTunnelUrl,
-  readLocalghostProjectConfig
-} from "@hamedb89/localghost";
-
-const { config } = await readLocalghostProjectConfig();
-const url = constructGhostTunnelUrl({
-  domain: "socialworkouts.app",
-  route: "plan",
-  project: "summer-base",
-  owner: "hamed",
-  ghostTunnel: config.ghostTunnel
-});
-
-const route = assertSecureGhostTunnelRequest({
-  host: request.headers.get("host") ?? "",
-  domain: "socialworkouts.app",
-  protocol: "https",
-  authenticated: Boolean(session),
-  ghostTunnel: config.ghostTunnel
-});
-```
-
-That constructs `https://plan-summer-base-hamed.ghost.socialworkouts.app/`, validates the same host shape, requires HTTPS by default, and requires the app to confirm auth by default. See [Ghost Tunnel](./docs/ghost-tunnel.md) for the production DNS and routing flow.
-
-When `ghostTunnel.preview` is configured, local route and Vite startup logs include the concrete URL as `expected: https://plan-summer-base-hamed.ghost.socialworkouts.app/`. In an interactive Vite terminal, press `g` to show the Ghost Tunnel configuration and open a numbered concrete URL. Wildcard `*` URLs are shown for clarity, but the menu only opens configured concrete domains.
-
-Relay guardrails are private-by-default: public requests never choose the local target, route registration requires a matching local-agent bearer token, signed route claims are exact/scoped/expiring, and default targets are limited to `localhost`, `127.0.0.1`, and `::1` with dangerous ports blocked. The package exports relay helpers for registration, target validation, header stripping, log redaction, limits, and safe offline responses.
-
-Local security checks:
-
-```sh
-npm test
-npm run test:cli
-npm run test:coverage
-```
-
-`localghost dev` and `localghost run` also register their active sessions in a user-local activity file. Use `localghost ps` to see the Localghost apps currently running on the machine:
-
-```txt
-localghost ps
-
-app  run: vite
-  cwd: /Users/you/Projects/app
-  pid: 12345, caddy: 12346, child: 12347
-  started: 2026-07-05T12:00:00.000Z
-  app.localhost -> 127.0.0.1:5173 (listening)
-```
-
-Pass `--json` when another helper, such as a menu bar app, needs to poll the same state.
-
-## macOS Widget
-
-Localghost includes a tiny native macOS widget in `apps/macos-widget`. One widget tracks all active Localghost sessions across the machine. It shows `LG n` in the top bar and opens a small floating desktop panel with the Localghost route list, target ports, and listening state.
-
-Build it from source:
-
-```sh
-npm run build
-npm run macos:widget:build
-```
-
-The app bundle is written to `dist/LocalghostWidget.app`. See [docs/macos-widget.md](./docs/macos-widget.md) for local development notes.
-
-## Vite
-
-```ts
-import { defineConfig } from "vite";
-import { localGhostPlugin } from "@hamedb89/localghost/vite";
-
-export default defineConfig({
-  plugins: [
-    localGhostPlugin({
-      port: 5173,
-      configFiles: [".localghost.private", ".localghost"]
-    })
-  ]
-});
-```
-
-The plugin binds Vite to `127.0.0.1` by default, prints the selected Localghost domain, generates an explicit `server.allowedHosts` list from the selected config file, and does not set `allowedHosts: true`. It runs only during local `vite serve`; production/build mode no-ops. Dynamic ports are enabled by default, so the plugin uses the configured port when available and otherwise moves to the next free port before Vite starts. Set `dynamicPort: false` when strict fixed-port behavior matters.
-
-If `.localghost` is missing and Vite is running in an interactive terminal, the plugin asks whether to create one, prompts for the primary domain and optional extra domains, and then asks whether to run setup. Before touching `/etc/hosts`, it explains why macOS may ask for your password and confirms that only Localghost's managed block is changed.
-
-When Vite starts, Localghost prints the browser-facing URLs:
-
-```txt
-localghost
-local:  http://app.localhost/
-also:   http://www.app.localhost/
-target: http://127.0.0.1:5173/
-```
-
-`https: true` means the browser-facing URL is expected to go through Caddy on HTTPS, while Vite still runs behind it on `127.0.0.1:<port>`. The plugin uses that to set Vite websocket/HMR proxy settings and to print `https://...` local host URLs. Localghost never opens browser tabs by default.
+## What It Does
 
-Set `log: false` if you want to keep Vite's default terminal output only.
+- Reads `.localghost` from your app repo and turns hostnames into local routes.
+- Updates only a managed Localghost block in `/etc/hosts` during explicit setup.
+- Generates `ops/local/Caddyfile` for local reverse proxying.
+- Keeps HTTP as the default; HTTPS is explicit with `--https`, `--ssl`, or config.
+- Checks whether Caddy is installed, but never installs Homebrew packages for you.
+- Gives Vite explicit `server.allowedHosts` entries without using `allowedHosts: true`.
+- Exposes CLI, config, state, and route output for scripts and agent workflows.
 
-## CLI
+## Common Commands
 
 ```sh
-localghost init
 localghost init --write-scripts
 localghost doctor
 localghost setup
-localghost setup --project app
-localghost setup --config .localghost.preview
-localghost setup --https
-localghost trust
-localghost status
 localghost status --ready
+localghost dev
+localghost run -- vite
+localghost routes
 localghost ps
-localghost ps --json
 localghost reset
 localghost teardown
-localghost teardown --remove-caddyfile
 localghost update
-localghost --no-update-check doctor
-localghost run -- vite
-localghost run --trust -- vite
-localghost run --dynamic-port=no -- vite
-localghost dev --config-pattern '^\.localghost\.'
-localghost dev --https
-localghost print
 ```
 
-Localghost checks npm for newer releases after successful commands. The check has a short timeout, is cached for 24 hours, and never fails the command. Disable it with `LOCALGHOST_NO_UPDATE_CHECK=1` or `--no-update-check`. Run `localghost update` when you want an explicit update check.
-
-`setup`, `dev`, and `teardown` refuse to run in production-like environments such as `NODE_ENV=production`, `VERCEL_ENV=production`, or `LOCALGHOST_ENV=production`.
+Prefer `.localhost` names. `.local` is supported, but Localghost warns because `.local` can collide with mDNS/Bonjour.
 
-When HTTPS is enabled, `localghost dev` and `localghost run` ask once whether to trust Caddy's local HTTPS CA. If you accept, macOS may ask for your password so Caddy can add its local CA to Keychain. Localghost records the result in `ops/local/localghost-state.json`; use `localghost trust` or `localghost run --trust -- ...` when you want to rerun the trust step intentionally.
+## Configuration
 
-`setup` writes only a managed block in the system hosts file:
+Most apps only need a `.localghost` file when they want explicit hostnames or multiple services:
 
 ```txt
-# localghost:start app
-127.0.0.1 app.localhost
-# localghost:end app
-```
-
-Localghost does not rewrite the whole hosts file. It replaces only its own managed block for the selected project.
-
-## Teardown And State
-
-`setup` writes a project-local state file at `ops/local/localghost-state.json`. It records the last Localghost action, selected config path, generated Caddyfile path, hosts file path, proxy mode, and the host entries that were applied. This is durable enough for project tooling and avoids relying on OS temp folders for tracking. Most apps should treat it as generated local state and ignore it in git.
-
-```sh
-localghost status
-localghost status --ready
-localghost status --json
+# Format: <host> <port>
+app.localhost 5173
+www.app.localhost 5173
+api.app.localhost 8787
 ```
 
-`localghost dev` requires setup to be ready before it starts Caddy. If setup is missing or stale, it prints the exact `localghost setup` command instead of silently running `sudo`. Use `localghost dev --setup` only when you explicitly want the dev command to perform setup first.
-
-When a project no longer needs Localghost, teardown removes only the managed hosts block for the selected project:
-
-```sh
-localghost teardown
-```
+Most repos do not need `localghost.config.mjs`. Add it only for decisions like HTTPS, dynamic-port behavior, `www.` aliases, custom config files, or `ghostTunnel` preview domains.
 
-When you want to retest setup without deleting `.localghost`, use reset:
+## Trust
 
-```sh
-localghost reset
-localghost setup
-```
+- CI runs typecheck, build, site build, and npm package dry-run on Node 20 and 22.
+- GitHub Pages is deployed by Actions from the checked-in `site/`, `docs/`, and `assets/` sources.
+- Preview the exact Pages artifact locally with `npm run site:serve`, then open `http://127.0.0.1:4173/`.
+- npm publish is guarded by `prepublishOnly` and the release workflow publishes with npm provenance.
+- Runtime dependencies are intentionally small: `commander` and `execa`. Vite is an optional peer dependency.
+- No postinstall scripts, hidden Homebrew installs, surprise browser tabs, or broad hosts-file rewrites.
+- Update checks are best-effort, cached for 24 hours, and can be disabled with `LOCALGHOST_NO_UPDATE_CHECK=1` or `--no-update-check`.
 
-The generated Caddyfile is left in place by default. Remove it explicitly when you want a fuller cleanup:
+## Docs
 
-```sh
-localghost teardown --remove-caddyfile
-```
+The full docs are served on GitHub Pages:
 
-Localghost still uses a short-lived OS temp file while copying `/etc/hosts` with `sudo`, but that temp file is not the source of truth.
+- [User flows](https://hamedb89.github.io/localghost/docs/flows/)
+- [CLI reference](https://hamedb89.github.io/localghost/docs/localghost.1/)
+- [Ghost Tunnel guide](https://hamedb89.github.io/localghost/docs/ghost-tunnel/)
+- [macOS widget notes](https://hamedb89.github.io/localghost/docs/macos-widget/)
+- [Brand guidelines](https://hamedb89.github.io/localghost/docs/brand/)
+- [All docs](https://hamedb89.github.io/localghost/docs/)
 
 ## API
 
@@ -511,35 +135,9 @@ import {
   updateSystemHosts
 } from "@hamedb89/localghost";
 
-readDevHosts({ configFiles: [".localghost.private", ".localghost"] });
-readDevHosts({ configPattern: /^\.localghost\.(private|preview)$/ });
-```
-
-Vite helper:
-
-```ts
 import { localGhostPlugin } from "@hamedb89/localghost/vite";
 ```
 
-`localHostsPlugin` is also exported as a compatibility alias.
-
-## More Docs
-
-Localghost copy can be mysterious, goofy, magical, funny, and a little absurd. The product behavior should stay boring in the best way: explicit commands, exact paths, clear errors, and no hidden installs.
-
-- [Website](https://hamedb89.github.io/localghost/)
-- [Brand guidelines](./docs/brand.md)
-- [Job-to-be-done flows](./docs/flows.md)
-- [CLI reference](./docs/localghost.1.md)
-
-## Assets
-
-<p align="center">
-  <img src="./assets/localghost-mascot.png" alt="Localghost mascot" width="180">
-  <br>
-  <img src="./assets/localghost-wordmark.png" alt="Localghost wordmark" width="420">
-</p>
-
 ## License
 
 MIT

package/dist/cli.js

@@ -495,8 +495,11 @@ function getDisplayValues(input2) {
     ...input2.values
   };
 }
+function getDisplayDefaults(config, defaults) {
+  return config.mode === "public" && !config.preview ? void 0 : defaults;
+}
 function createDisplayUrl(config, defaults, domain) {
-  const input2 = getPreviewDefaults(config.preview, defaults);
+  const input2 = getPreviewDefaults(config.preview, getDisplayDefaults(config, defaults));
   const protocol = input2.protocol ?? "https";
   const slug = createNamespaceDisplaySlug(config.namespace, getDisplayValues(input2));
   const entryHost = domain ? getGhostTunnelEntryHost(domain, config) : input2.domain ? getGhostTunnelEntryHost(input2.domain, config) : `${config.subdomain}.*`;
@@ -505,8 +508,9 @@ function createDisplayUrl(config, defaults, domain) {
   return `${url}${input2.path.replace(/^\/+/, "")}`;
 }
 function createDisplayUrls(config, defaults) {
-  const domains = config.domains.length > 0 ? config.domains : defaults?.domain ? [defaults.domain] : [];
-  const urls = domains.length > 0 ? domains.map((domain) => createDisplayUrl(config, defaults, domain)) : [createDisplayUrl(config, defaults)];
+  const displayDefaults = getDisplayDefaults(config, defaults);
+  const domains = config.domains.length > 0 ? config.domains : displayDefaults?.domain ? [displayDefaults.domain] : [];
+  const urls = domains.length > 0 ? domains.map((domain) => createDisplayUrl(config, displayDefaults, domain)) : [createDisplayUrl(config, displayDefaults)];
   return [...new Set(urls)];
 }
 function maybeConstructPreviewUrl(config, defaults) {
@@ -1091,7 +1095,7 @@ import { existsSync as existsSync6, mkdirSync as mkdirSync3, readFileSync as rea
 import { homedir as homedir2 } from "os";
 import { dirname as dirname4, join as join8 } from "path";
 var LOCALGHOST_PACKAGE_NAME = "@hamedb89/localghost";
-var LOCALGHOST_VERSION = "0.1.9";
+var LOCALGHOST_VERSION = "0.1.10";
 var UPDATE_CHECK_CACHE_TTL_MS = 24 * 60 * 60 * 1e3;
 var UPDATE_CHECK_NOTIFY_TTL_MS = 24 * 60 * 60 * 1e3;
 var UPDATE_CHECK_TIMEOUT_MS = 900;