@hamedb89/localghost 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hamed Bahrami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,278 @@
+<p align="center">
+  <img src="./assets/localghost-banner.png" alt="Localghost - Friendly local hostnames" width="960">
+</p>
+
+# @hamedb89/localghost
+
+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)
+
+Localghost is a tiny Node.js CLI for local HTTPS domains in app repos. It gives each project one small contract for `.localhost` hostnames, Caddy reverse proxies, Vite `allowedHosts`, and the system hosts file, so developers can open `https://app.localhost/` instead of remembering which localhost 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)
+
+## 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 HTTPS reverse proxying.
+- Checks whether Caddy is installed, but does not run Homebrew for you.
+- Provides a Vite plugin that sets explicit `server.allowedHosts` entries.
+- 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.
+- 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>
+
+## Install
+
+```sh
+yarn add -D @hamedb89/localghost
+```
+
+## Quick Start
+
+Create the project config and optional package scripts:
+
+```sh
+yarn localghost init --write-scripts
+```
+
+This creates `.localghost`:
+
+```txt
+# Buh. Friendly names for local services.
+# Format: <host> <port>
+app.localhost 5173
+www.app.localhost 5173
+api.app.localhost 8787
+```
+
+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.
+```
+
+First time on a machine:
+
+```sh
+yarn localghost:setup
+```
+
+Daily proxy:
+
+```sh
+yarn localghost:proxy
+```
+
+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:print": "localghost print",
+    "localghost:routes": "localghost routes",
+    "localghost:status": "localghost status",
+    "localghost:teardown": "localghost teardown",
+    "localghost:doctor": "localghost doctor",
+    "localghost:update": "localghost update"
+  }
+}
+```
+
+A full app might compose them with its own servers:
+
+```json
+{
+  "scripts": {
+    "dev:web": "vite --host 127.0.0.1 --port 5173 --strictPort",
+    "dev:api": "wrangler dev --port 8787",
+    "dev:local": "concurrently -k \"npm run dev:web\" \"npm run dev:api\" \"npm run localghost:proxy\""
+  }
+}
+```
+
+## Vite
+
+```ts
+import { defineConfig } from "vite";
+import { localGhostPlugin } from "@hamedb89/localghost/vite";
+
+export default defineConfig({
+  plugins: [
+    localGhostPlugin({
+      port: 5173,
+      https: true,
+      configFiles: [".localghost.private", ".localghost"]
+    })
+  ]
+});
+```
+
+The plugin generates an explicit `server.allowedHosts` list from the selected config file; it does not set `allowedHosts: true`.
+
+When Vite starts, Localghost prints the browser-facing URLs:
+
+```txt
+localghost
+open:   https://app.localhost/
+also:   https://www.app.localhost/
+target: http://127.0.0.1:5173/
+proxy:  Caddy local HTTPS
+```
+
+`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.
+
+Set `log: false` if you want to keep Vite's default terminal output only.
+
+## CLI
+
+```sh
+localghost init
+localghost init --write-scripts
+localghost doctor
+localghost setup
+localghost setup --project app
+localghost setup --config .localghost.preview
+localghost status
+localghost teardown
+localghost teardown --remove-caddyfile
+localghost update
+localghost --no-update-check doctor
+localghost dev --config-pattern '^\.localghost\.'
+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` writes only a managed block in the system hosts file:
+
+```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, 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 --json
+```
+
+When a project no longer needs Localghost, teardown removes only the managed hosts block for the selected project:
+
+```sh
+localghost teardown
+```
+
+The generated Caddyfile is left in place by default. Remove it explicitly when you want a fuller cleanup:
+
+```sh
+localghost teardown --remove-caddyfile
+```
+
+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.
+
+## API
+
+```ts
+import {
+  getConfigFileCandidates,
+  initLocalghost,
+  readDevHosts,
+  readLocalghostState,
+  removeSystemHosts,
+  renderCaddyfile,
+  renderHostsBlock,
+  runDoctor,
+  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.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node