portless 0.5.2 → 0.7.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Vercel Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,107 +1,100 @@
 # portless
 
-Replace port numbers with stable, named .localhost URLs. For humans and agents.
+Replace port numbers with stable, named .localhost URLs for local development. For humans and agents.
 
 ```diff
-- "dev": "next dev"              # http://localhost:3000
-+ "dev": "portless run next dev"   # http://myapp.localhost:1355
+- "dev": "next dev"                  # http://localhost:3000
++ "dev": "portless run next dev"     # https://myapp.localhost
 ```
 
-## Quick Start
+## Install
 
 ```bash
-# Install
 npm install -g portless
+```
+
+> Install globally. Do not add as a project dependency or run via npx.
+
+## Run your app
+
+```bash
+# Enable HTTPS (one-time setup, auto-generates certs)
+portless proxy start --https
 
-# Run your app (auto-starts the proxy if needed)
-portless run next dev
-# -> http://<project>.localhost:1355
+portless myapp next dev
+# -> https://myapp.localhost
 
-# Or specify a name explicitly
+# Without --https, runs on port 1355
 portless myapp next dev
 # -> http://myapp.localhost:1355
 ```
 
-> The proxy auto-starts when you run an app. You can also start it explicitly with `portless proxy start`.
-
-## Why
+The proxy auto-starts when you run an app. A random port (4000--4999) is assigned via the `PORT` environment variable. Most frameworks (Next.js, Express, Nuxt, etc.) respect this automatically. For frameworks that ignore `PORT` (Vite, Astro, React Router, Angular), portless auto-injects `--port` and `--host` flags.
 
-Local dev with port numbers is fragile:
+## Use in package.json
 
-- **Port conflicts** -- two projects default to the same port and you get `EADDRINUSE`
-- **Memorizing ports** -- was the API on 3001 or 8080?
-- **Refreshing shows the wrong app** -- stop one server, start another on the same port, and your open tab now shows something completely different
-- **Monorepo multiplier** -- every problem above scales with each service in the repo
-- **Agents test the wrong port** -- AI coding agents guess or hardcode the wrong port, especially in monorepos
-- **Cookie and storage clashes** -- cookies set on `localhost` bleed across apps on different ports; localStorage is lost when ports shift
-- **Hardcoded ports in config** -- CORS allowlists, OAuth redirect URIs, and `.env` files all break when ports change
-- **Sharing URLs with teammates** -- "what port is that on?" becomes a Slack question
-- **Browser history is useless** -- your history for `localhost:3000` is a jumble of unrelated projects
+```json
+{
+  "scripts": {
+    "dev": "portless run next dev"
+  }
+}
+```
 
-Portless fixes all of this by giving each dev server a stable, named `.localhost` URL that both humans and agents can rely on.
+## Subdomains
 
-## Usage
+Organize services with subdomains:
 
 ```bash
-# Auto-infer name from package.json / git / directory
-portless run next dev
-# -> http://<project>.localhost:1355
-
-# Explicit name
-portless myapp next dev
-# -> http://myapp.localhost:1355
-
-# Subdomains
 portless api.myapp pnpm start
 # -> http://api.myapp.localhost:1355
 
 portless docs.myapp next dev
 # -> http://docs.myapp.localhost:1355
-
-# Wildcard subdomains (no extra registration needed)
-# Any subdomain of a registered route routes automatically:
-#   tenant1.myapp.localhost:1355  -> myapp
-#   tenant2.myapp.localhost:1355  -> myapp
 ```
 
-### Git Worktrees
+Wildcard subdomain routing: any subdomain of a registered route routes to that app automatically (e.g. `tenant1.myapp.localhost:1355` routes to the `myapp` app without extra registration).
 
-`portless run` automatically detects git worktrees. When you're in a linked worktree, the branch name is prepended as a subdomain so each worktree gets its own URL without any config changes:
+## Git Worktrees
+
+`portless run` automatically detects git worktrees. In a linked worktree, the branch name is prepended as a subdomain so each worktree gets its own URL without any config changes:
 
 ```bash
-# Main worktree (main/master branch) -- no prefix, works normally
-portless run next dev
-# -> http://myapp.localhost:1355
+# Main worktree -- no prefix
+portless run next dev   # -> http://myapp.localhost:1355
 
-# Linked worktree on branch "fix-ui" -- branch name becomes a prefix
-portless run next dev
-# -> http://fix-ui.myapp.localhost:1355
+# Linked worktree on branch "fix-ui"
+portless run next dev   # -> http://fix-ui.myapp.localhost:1355
+```
 
-# Linked worktree on branch "feature/auth" -- uses last segment
-portless run next dev
-# -> http://auth.myapp.localhost:1355
+Use `--name` to override the inferred base name while keeping the worktree prefix:
+
+```bash
+portless run --name myapp next dev   # -> http://fix-ui.myapp.localhost:1355
 ```
 
-This means you can put `portless run` in your `package.json` once and it just works everywhere -- the main checkout uses the plain name, and each worktree gets a unique subdomain. No `--force` needed, no name collisions.
+Put `portless run` in your `package.json` once and it works everywhere -- the main checkout uses the plain name, each worktree gets a unique subdomain. No collisions, no `--force`.
 
-### In package.json
+## Custom TLD
 
-```json
-{
-  "scripts": {
-    "dev": "portless run next dev"
-  }
-}
+By default, portless uses `.localhost` which auto-resolves to `127.0.0.1` in most browsers. If you prefer a different TLD (e.g. `.test`), use `--tld`:
+
+```bash
+sudo portless proxy start --https --tld test
+portless myapp next dev
+# -> https://myapp.test
 ```
 
-The proxy auto-starts when you run an app. Or start it explicitly: `portless proxy start`.
+The proxy auto-syncs `/etc/hosts` for custom TLDs when started with sudo, so `.test` domains resolve correctly.
+
+Recommended: `.test` (IANA-reserved, no collision risk). Avoid `.local` (conflicts with mDNS/Bonjour) and `.dev` (Google-owned, forces HTTPS via HSTS).
 
-## How It Works
+## How it works
 
 ```mermaid
 flowchart TD
     Browser["Browser\nmyapp.localhost:1355"]
-    Proxy["portless proxy<br>(port 1355)"]
+    Proxy["portless proxy\n(port 1355)"]
     App1[":4123\nmyapp"]
     App2[":4567\napi"]
 
@@ -114,8 +107,6 @@ flowchart TD
 2. **Run apps** -- `portless <name> <command>` assigns a free port and registers with the proxy
 3. **Access via URL** -- `http://<name>.localhost:1355` routes through the proxy to your app
 
-Apps are assigned a random port (4000-4999) via the `PORT` and `HOST` environment variables. Most frameworks (Next.js, Express, Nuxt, etc.) respect these automatically. For frameworks that ignore `PORT` (Vite, Astro, React Router, Angular, Expo, React Native), portless auto-injects the correct `--port` and `--host` flags.
-
 ## HTTP/2 + HTTPS
 
 Enable HTTP/2 for faster dev server page loads. Browsers limit HTTP/1.1 to 6 connections per host, which bottlenecks dev servers that serve many unbundled files (Vite, Nuxt, etc.). HTTP/2 multiplexes all requests over a single connection.
@@ -138,12 +129,12 @@ portless proxy start --cert ./cert.pem --key ./key.pem
 sudo portless trust
 ```
 
-On Linux, `portless trust` supports Debian/Ubuntu, Arch, Fedora/RHEL/CentOS, and openSUSE (via `update-ca-certificates` or `update-ca-trust`).
+On Linux, `portless trust` supports Debian/Ubuntu, Arch, Fedora/RHEL/CentOS, and openSUSE (via `update-ca-certificates` or `update-ca-trust`). On Windows, it uses `certutil` to add the CA to the system trust store.
 
 ## Commands
 
 ```bash
-portless run <cmd> [args...]     # Infer name from project, run through proxy
+portless run [--name <name>] <cmd> [args...]  # Infer name (or override with --name), run through proxy
 portless <name> <cmd> [args...]  # Run app at http://<name>.localhost:1355
 portless alias <name> <port>     # Register a static route (e.g. for Docker)
 portless alias <name> <port> --force  # Overwrite an existing route
@@ -155,7 +146,6 @@ portless hosts clean             # Remove portless entries from /etc/hosts
 
 # Disable portless (run command directly)
 PORTLESS=0 pnpm dev              # Bypasses proxy, uses default port
-# Also accepts PORTLESS=skip
 
 # Proxy control
 portless proxy start             # Start the proxy (port 1355, daemon)
@@ -163,64 +153,42 @@ portless proxy start --https     # Start with HTTP/2 + TLS
 portless proxy start -p 80       # Start on port 80 (requires sudo)
 portless proxy start --foreground  # Start in foreground (for debugging)
 portless proxy stop              # Stop the proxy
-
-# Options
--p, --port <number>              # Port for the proxy (default: 1355)
-                                 # Ports < 1024 require sudo
---https                          # Enable HTTP/2 + TLS with auto-generated certs
---cert <path>                    # Use a custom TLS certificate (implies --https)
---key <path>                     # Use a custom TLS private key (implies --https)
---no-tls                         # Disable HTTPS (overrides PORTLESS_HTTPS)
---foreground                     # Run proxy in foreground instead of daemon
---app-port <number>              # Use a fixed port for the app (skip auto-assignment)
---force                          # Override a route registered by another process
---name <name>                    # Use <name> as the app name (bypasses subcommand dispatch)
---                               # Stop flag parsing; everything after is passed to the child
-
-# Injected into child processes
-PORT                             # Ephemeral port the child should listen on
-HOST                             # Always 127.0.0.1
-PORTLESS_URL                     # Public URL (e.g. http://myapp.localhost:1355)
-
-# Configuration
-PORTLESS_PORT=<number>           # Override the default proxy port
-PORTLESS_APP_PORT=<number>       # Use a fixed port for the app (same as --app-port)
-PORTLESS_HTTPS=1|true            # Always enable HTTPS
-PORTLESS_SYNC_HOSTS=1            # Auto-sync /etc/hosts when routes change
-PORTLESS_STATE_DIR=<path>        # Override the state directory
-
-# Info
-portless --help                  # Show help
-portless run --help              # Show help for a specific subcommand
-portless --version               # Show version
 ```
 
-> **Reserved names:** `run`, `alias`, `hosts`, `list`, `trust`, and `proxy` are subcommands and cannot be used as app names directly. Use `portless run <cmd>` to infer the name from your project, or `portless --name <name> <cmd>` to force any name including reserved ones.
-
-## State Directory
-
-Portless stores its state (routes, PID file, port file) in a directory that depends on the proxy port:
-
-- **Port < 1024** (sudo required): `/tmp/portless` -- shared between root and user processes
-- **Port >= 1024** (no sudo): `~/.portless` -- user-scoped, no root involvement
+### Options
 
-Override with the `PORTLESS_STATE_DIR` environment variable if needed.
+```
+-p, --port <number>              Port for the proxy (default: 1355)
+--https                          Enable HTTP/2 + TLS with auto-generated certs
+--cert <path>                    Use a custom TLS certificate (implies --https)
+--key <path>                     Use a custom TLS private key (implies --https)
+--no-tls                         Disable HTTPS (overrides PORTLESS_HTTPS)
+--foreground                     Run proxy in foreground instead of daemon
+--tld <tld>                      Use a custom TLD instead of .localhost (e.g. test)
+--app-port <number>              Use a fixed port for the app (skip auto-assignment)
+--force                          Override a route registered by another process
+--name <name>                    Use <name> as the app name
+```
 
-## Development
+### Environment variables
 
-This repo is a pnpm workspace monorepo using [Turborepo](https://turbo.build). The publishable package lives in `packages/portless/`.
+```
+# Configuration
+PORTLESS_PORT=<number>           Override the default proxy port
+PORTLESS_APP_PORT=<number>       Use a fixed port for the app (same as --app-port)
+PORTLESS_HTTPS=1                 Always enable HTTPS
+PORTLESS_TLD=<tld>               Use a custom TLD (e.g. test; default: localhost)
+PORTLESS_SYNC_HOSTS=1            Auto-sync /etc/hosts (auto-enabled for custom TLDs)
+PORTLESS_STATE_DIR=<path>        Override the state directory
 
-```bash
-pnpm install          # Install all dependencies
-pnpm build            # Build all packages
-pnpm test             # Run tests
-pnpm test:coverage    # Run tests with coverage
-pnpm test:watch       # Run tests in watch mode
-pnpm lint             # Lint all packages
-pnpm typecheck        # Type-check all packages
-pnpm format           # Format all files with Prettier
+# Injected into child processes
+PORT                             Ephemeral port the child should listen on
+HOST                             Always 127.0.0.1
+PORTLESS_URL                     Public URL (e.g. https://myapp.localhost)
 ```
 
+> **Reserved names:** `run`, `get`, `alias`, `hosts`, `list`, `trust`, and `proxy` are subcommands and cannot be used as app names directly. Use `portless run <cmd>` to infer the name from your project, or `portless --name <name> <cmd>` to force any name including reserved ones.
+
 ## Safari / DNS
 
 `.localhost` subdomains auto-resolve to `127.0.0.1` in Chrome, Firefox, and Edge. Safari relies on the system DNS resolver, which may not handle `.localhost` subdomains on all configurations.
@@ -228,23 +196,15 @@ pnpm format           # Format all files with Prettier
 If Safari can't find your `.localhost` URL:
 
 ```bash
-# Add current routes to /etc/hosts (requires sudo)
-sudo portless hosts sync
-
-# Clean up later
-sudo portless hosts clean
+sudo portless hosts sync    # Add current routes to /etc/hosts
+sudo portless hosts clean   # Clean up later
 ```
 
-To auto-sync `/etc/hosts` whenever routes change, set `PORTLESS_SYNC_HOSTS=1` and start the proxy with sudo:
-
-```bash
-export PORTLESS_SYNC_HOSTS=1
-sudo portless proxy start
-```
+Auto-syncs `/etc/hosts` for custom TLDs (e.g. `--tld test`). For `.localhost`, set `PORTLESS_SYNC_HOSTS=1` to enable. Disable with `PORTLESS_SYNC_HOSTS=0`.
 
 ## Proxying Between Portless Apps
 
-If your frontend dev server (e.g. Vite, webpack) proxies API requests to another portless app, make sure the proxy rewrites the `Host` header. Without this, the proxy sends the **original** Host header, causing portless to route the request back to the frontend in an infinite loop.
+If your frontend dev server (e.g. Vite, webpack) proxies API requests to another portless app, make sure the proxy rewrites the `Host` header. Without this, portless routes the request back to the frontend in an infinite loop.
 
 **Vite** (`vite.config.ts`):
 
@@ -253,7 +213,7 @@ server: {
   proxy: {
     "/api": {
       target: "http://api.myapp.localhost:1355",
-      changeOrigin: true,  // Required: rewrites Host header to match target
+      changeOrigin: true,
       ws: true,
     },
   },
@@ -267,14 +227,28 @@ devServer: {
   proxy: [{
     context: ["/api"],
     target: "http://api.myapp.localhost:1355",
-    changeOrigin: true,  // Required: rewrites Host header to match target
+    changeOrigin: true,
   }],
 }
 ```
 
 Portless detects this misconfiguration and responds with `508 Loop Detected` along with a message pointing to this fix.
 
+## Development
+
+This repo is a pnpm workspace monorepo using [Turborepo](https://turbo.build). The publishable package lives in `packages/portless/`.
+
+```bash
+pnpm install          # Install all dependencies
+pnpm build            # Build all packages
+pnpm test             # Run tests
+pnpm test:coverage    # Run tests with coverage
+pnpm lint             # Lint all packages
+pnpm typecheck        # Type-check all packages
+pnpm format           # Format all files with Prettier
+```
+
 ## Requirements
 
 - Node.js 20+
-- macOS or Linux
+- macOS, Linux, or Windows