Portless Integration
Named .localhost URLs for local development. Replaces localhost:3000 with https://myapp.localhost.
Full CLI reference: Load Read("references/upstream.md") for complete command docs.
New in 2026-04 → 2026-07 (portless 0.10.x → 0.15.0)
portless doctor (0.15.0) — read-only diagnostics that check Node.js, the state directory, proxy liveness, route entries, hostname resolution, HTTPS CA trust, and LAN prerequisites, then print suggested fixes. Run it before filing an issue or when a .localhost URL won't resolve.
- HTTP/2 Host forwarding fix (0.15.0) — the proxy now forwards the HTTP/2
:authority as Host to HTTP/1.1 backends, fixing apps that read Host and previously saw 127.0.0.1 for browser traffic. --force takeover cleanup now removes only routes still owned by the exiting process, so a forced takeover no longer deregisters the new owner's route.
--ngrok flag (0.14.0) — share an app publicly via ngrok while local access keeps its .localhost URL. Pair with the existing Tailscale/Funnel options when you need a public URL without giving up the named-subdomain dev experience.
- Node.js 24+ required (0.13.1, BREAKING) — the proxy and CLI now require Node.js 24 or newer; older runtimes are unsupported. This release also hardens startup-service persistence so
.localhost URLs survive reboot reliably.
- State directory moved to
~/.portless (0.11, BREAKING) — state relocated from scattered/temp locations to ~/.portless; override with PORTLESS_STATE_DIR. Old state from pre-0.11 installs is not migrated automatically.
- OS startup service (0.13.0) —
portless service install / service status / service uninstall register a native startup service for the HTTPS proxy across macOS launchd, Linux systemd, and Windows Task Scheduler. .localhost URLs survive reboot without a manual portless proxy start. portless clean removes the service alongside CA + hosts cleanup.
- Tailscale readiness preflight (0.13.0) —
--tailscale and --funnel now validate Tailscale HTTPS + Funnel prerequisites before starting the child process, surfacing actionable errors instead of hanging during registration.
- Tailscale integration (0.12.0) —
--tailscale shares your app over your tailnet with automatic HTTPS on port 443; --funnel exposes it publicly via Tailscale Funnel. Apps receive PORTLESS_TAILSCALE_URL so they can reference their own public address. portless list now shows tailnet URLs.
- Zero-config mode (0.11.0) — bare
portless auto-discovers dev scripts from package.json. Multi-app monorepos get automatic subdomain assignment; Turborepo task-graph integration is wired in. portless.json config file supported. --script overrides the default "dev" script.
portless prune — removes orphaned dev servers and stale Tailscale registrations.
portless clean (extended) — now also tears down Tailscale registrations alongside CA + hosts cleanup.
- Rsbuild + VitePlus auto-port injection — same auto-wiring as Vite/Next.
- State directory moved to
~/.portless (was scattered).
- HTTPS on 443 by default (breaking from 0.9.x http:1355). Valid cert, no setup.
--no-tls reverts.
NODE_EXTRA_CA_CERTS auto-injected (0.10.2) into child processes — node HTTPS calls trust portless CA with zero setup.
--wildcard subdomains — https://*.myapp.localhost for multi-tenant / preview routing.
portless alias <name> <port> — map a docker-compose / emulate port to a named URL without a long-running run process.
portless clean — full teardown: stops proxy, removes CA, wipes state, cleans /etc/hosts.
--lan mode — mDNS .local hostnames reachable across wifi (phone, tablet, other machines) without router config.
- Fixed app ports —
--app-port 3000 / PORTLESS_APP_PORT for tools that need a known port (debuggers, docker).
- hosts-sync on by default for Safari compat (disable with
PORTLESS_SYNC_HOSTS=0).
- HTTP/2 HMR fixes for Vite/VitePlus/Next.js dev — websocket upgrades no longer break under h2.
- Expo / React Native support —
portless run expo start gives Metro a stable URL for device QR codes.
When to Use
- Starting a dev server that agents or browser tests will target
- Running multiple services locally (API + frontend + docs)
- Working in git worktrees (branch-named subdomains)
- Local OAuth flows (stable callback URLs)
- Connecting emulate API mocks to named URLs
Quick Start
# Instead of: npm run dev (random port)
portless run npm run dev
# → https://myapp.localhost (stable, named, HTTPS on 443 — default in 0.10+)
# Multi-service
portless run --name api npm run dev:api
portless run --name web npm run dev:web
# → https://api.localhost, https://web.localhost
# LAN mode (0.10.0) — reachable from phone/tablet via mDNS
portless proxy start --lan
portless run npm run dev
# → https://myapp.local (resolves across the local network, no router config)
# Full teardown (0.10.1) — stops proxy, removes CA, wipes state, cleans /etc/hosts
portless clean
# Boot persistence (0.13.0) — install native startup service (launchd / systemd / Task Scheduler)
portless service install
portless service status
# Removed automatically by `portless clean`, or explicitly:
portless service uninstall
0.10.x breaking change: default switched from https://app.localhost to https://app.localhost on port 443. Use --no-tls to revert. NODE_EXTRA_CA_CERTS is injected into child processes automatically (0.10.2) — no manual cert setup. /etc/hosts is synced automatically for Safari; disable with PORTLESS_SYNC_HOSTS=0.
Framework-Specific Setup
Load Read("references/framework-integration.md") for full framework recipes.
Most frameworks (Next.js, Vite, Express) work with portless run <cmd>. Some need explicit flags:
| Framework |
Auto-detected? |
Extra flags needed |
| Next.js |
Yes |
None |
| Vite / Astro |
Yes |
None |
| Express / Fastify / Hono |
Yes |
None (reads PORT env var) |
| Ruby on Rails |
Yes |
None |
| FastAPI / uvicorn |
No |
--port $PORT --host $HOST |
| Django |
No |
$HOST:$PORT positional arg |
Why .localhost?
| Feature |
.localhost (RFC 6761) |
127.0.0.1:PORT |
/etc/hosts hack |
No /etc/hosts editing |
Yes |
Yes |
No |
| HTTPS with valid cert |
Yes |
No |
Manual |
| Wildcard subdomains |
Yes |
No |
No |
| Works in all browsers |
Yes |
Yes |
Varies |
| Cookie isolation per service |
Yes |
No |
Yes |
| No port conflicts |
Yes |
No |
Yes |
Key Environment Variables
When portless runs your command, it injects:
| Variable |
Value |
Use in agents |
PORT |
Assigned ephemeral port (4000-4999) |
Internal only |
HOST |
127.0.0.1 |
Internal only |
PORTLESS_URL |
https://myapp.localhost |
Use this in agent prompts |
NODE_EXTRA_CA_CERTS |
Path to portless CA (auto-injected 0.10.2) |
Child node processes trust portless certs without setup |
Toggle env vars
| Variable |
Effect |
PORTLESS=0 |
Bypass portless entirely (CI) |
PORTLESS_SYNC_HOSTS=0 |
Disable auto /etc/hosts sync (default: on in 0.10.1+) |
PORTLESS_STATE_DIR |
Override state dir (default: ~/.portless or /tmp/portless for privileged ports) |
OrchestKit Integration Patterns
1. Agent-Accessible Dev Server
# Start with portless, then agents can target PORTLESS_URL
portless run npm run dev
# In ork:expect or agent-browser:
agent-browser open $PORTLESS_URL
2. Emulate + Portless (Named API Mocks)
# Register emulate ports as named aliases
portless alias github-api 4001
portless alias vercel-api 4000
portless alias google-api 4002
# Now agents can target:
# https://github-api.localhost — GitHub emulator
# https://vercel-api.localhost — Vercel emulator
3. Git Worktree Dev
# In worktree for feature/auth-flow:
portless run npm run dev
# → https://auth-flow.myapp.localhost (auto branch prefix)
4. Bypass in CI
# Disable portless in CI — direct port access
PORTLESS=0 npm run dev
Anti-Patterns
| Don't |
Do Instead |
Hardcode localhost:3000 in tests |
Use PORTLESS_URL or process.env.PORTLESS_URL |
| Run portless in CI |
Set PORTLESS=0 in CI environments |
| Use numeric ports in AGENTS.md |
Document the portless URL |
References
| File |
Content |
references/upstream.md |
Full portless CLI reference (synced from Vercel) |
references/upstream-oauth.md |
OAuth callback patterns with stable URLs |
references/framework-integration.md |
Framework recipes (FastAPI, Django, Docker, gotchas) |
checklists/new-project-setup.md |
Step-by-step: add portless to a new project |
1---2name: portless3compatibility: "Claude Code 2.1.277+"4description: "Named HTTPS .localhost URLs with portless (v0.15.x): no port collisions, branch subdomains for worktrees, LAN and Tailscale sharing. Use for local dev URLs. Not for production, CI or DNS hosting."5user-invocable: false6context: inherit7metadata:8 source: https://skillmd.com/skills/yonatangross/portless9 upstream-package: portless10 upstream-version-tested: "0.15.6"11 version: "1.2.0"12 author: "OrchestKit"13 complexity: "low"14 tags: "dev-server, localhost, https, portless, devops, mdns, lan"15---1617# Portless Integration1819Named `.localhost` URLs for local development. Replaces `localhost:3000` with `https://myapp.localhost`.2021> **Full CLI reference**: Load `Read("references/upstream.md")` for complete command docs.2223## New in 2026-04 → 2026-07 (portless 0.10.x → 0.15.0)2425- **`portless doctor` (0.15.0)** — read-only diagnostics that check Node.js, the state directory, proxy liveness, route entries, hostname resolution, HTTPS CA trust, and LAN prerequisites, then print suggested fixes. Run it before filing an issue or when a `.localhost` URL won't resolve.26- **HTTP/2 Host forwarding fix (0.15.0)** — the proxy now forwards the HTTP/2 `:authority` as `Host` to HTTP/1.1 backends, fixing apps that read `Host` and previously saw `127.0.0.1` for browser traffic. `--force` takeover cleanup now removes only routes still owned by the exiting process, so a forced takeover no longer deregisters the new owner's route.27- **`--ngrok` flag (0.14.0)** — share an app publicly via ngrok while local access keeps its `.localhost` URL. Pair with the existing Tailscale/Funnel options when you need a public URL without giving up the named-subdomain dev experience.28- **Node.js 24+ required (0.13.1, BREAKING)** — the proxy and CLI now require Node.js 24 or newer; older runtimes are unsupported. This release also hardens startup-service persistence so `.localhost` URLs survive reboot reliably.29- **State directory moved to `~/.portless` (0.11, BREAKING)** — state relocated from scattered/temp locations to `~/.portless`; override with `PORTLESS_STATE_DIR`. Old state from pre-0.11 installs is not migrated automatically.30- **OS startup service (0.13.0)** — `portless service install` / `service status` / `service uninstall` register a native startup service for the HTTPS proxy across macOS launchd, Linux systemd, and Windows Task Scheduler. `.localhost` URLs survive reboot without a manual `portless proxy start`. `portless clean` removes the service alongside CA + hosts cleanup.31- **Tailscale readiness preflight (0.13.0)** — `--tailscale` and `--funnel` now validate Tailscale HTTPS + Funnel prerequisites before starting the child process, surfacing actionable errors instead of hanging during registration.32- **Tailscale integration (0.12.0)** — `--tailscale` shares your app over your tailnet with automatic HTTPS on port 443; `--funnel` exposes it publicly via Tailscale Funnel. Apps receive `PORTLESS_TAILSCALE_URL` so they can reference their own public address. `portless list` now shows tailnet URLs.33- **Zero-config mode (0.11.0)** — bare `portless` auto-discovers dev scripts from `package.json`. Multi-app monorepos get automatic subdomain assignment; Turborepo task-graph integration is wired in. `portless.json` config file supported. `--script` overrides the default "dev" script.34- **`portless prune`** — removes orphaned dev servers and stale Tailscale registrations.35- **`portless clean` (extended)** — now also tears down Tailscale registrations alongside CA + hosts cleanup.36- **Rsbuild + VitePlus auto-port injection** — same auto-wiring as Vite/Next.37- **State directory** moved to `~/.portless` (was scattered).38- **HTTPS on 443 by default** (breaking from 0.9.x http:1355). Valid cert, no setup. `--no-tls` reverts.39- **`NODE_EXTRA_CA_CERTS` auto-injected (0.10.2)** into child processes — node HTTPS calls trust portless CA with zero setup.40- **`--wildcard` subdomains** — `https://*.myapp.localhost` for multi-tenant / preview routing.41- **`portless alias <name> <port>`** — map a docker-compose / emulate port to a named URL without a long-running `run` process.42- **`portless clean`** — full teardown: stops proxy, removes CA, wipes state, cleans `/etc/hosts`.43- **`--lan` mode** — mDNS `.local` hostnames reachable across wifi (phone, tablet, other machines) without router config.44- **Fixed app ports** — `--app-port 3000` / `PORTLESS_APP_PORT` for tools that need a known port (debuggers, docker).45- **hosts-sync on by default** for Safari compat (disable with `PORTLESS_SYNC_HOSTS=0`).46- **HTTP/2 HMR fixes** for Vite/VitePlus/Next.js dev — websocket upgrades no longer break under h2.47- **Expo / React Native** support — `portless run expo start` gives Metro a stable URL for device QR codes.4849## When to Use5051- Starting a dev server that agents or browser tests will target52- Running multiple services locally (API + frontend + docs)53- Working in git worktrees (branch-named subdomains)54- Local OAuth flows (stable callback URLs)55- Connecting emulate API mocks to named URLs5657## Quick Start5859```bash60# Instead of: npm run dev (random port)61portless run npm run dev62# → https://myapp.localhost (stable, named, HTTPS on 443 — default in 0.10+)6364# Multi-service65portless run --name api npm run dev:api66portless run --name web npm run dev:web67# → https://api.localhost, https://web.localhost6869# LAN mode (0.10.0) — reachable from phone/tablet via mDNS70portless proxy start --lan71portless run npm run dev72# → https://myapp.local (resolves across the local network, no router config)7374# Full teardown (0.10.1) — stops proxy, removes CA, wipes state, cleans /etc/hosts75portless clean7677# Boot persistence (0.13.0) — install native startup service (launchd / systemd / Task Scheduler)78portless service install79portless service status80# Removed automatically by `portless clean`, or explicitly:81portless service uninstall82```8384> **0.10.x breaking change:** default switched from `https://app.localhost` to `https://app.localhost` on port 443. Use `--no-tls` to revert. `NODE_EXTRA_CA_CERTS` is injected into child processes automatically (0.10.2) — no manual cert setup. `/etc/hosts` is synced automatically for Safari; disable with `PORTLESS_SYNC_HOSTS=0`.8586## Framework-Specific Setup8788> Load `Read("references/framework-integration.md")` for full framework recipes.8990Most frameworks (Next.js, Vite, Express) work with `portless run <cmd>`. Some need explicit flags:9192| Framework | Auto-detected? | Extra flags needed |93|-----------|:-:|---|94| Next.js | Yes | None |95| Vite / Astro | Yes | None |96| Express / Fastify / Hono | Yes | None (reads `PORT` env var) |97| Ruby on Rails | Yes | None |98| FastAPI / uvicorn | **No** | `--port $PORT --host $HOST` |99| Django | **No** | `$HOST:$PORT` positional arg |100101## Why `.localhost`?102103| Feature | `.localhost` (RFC 6761) | `127.0.0.1:PORT` | `/etc/hosts` hack |104|---------|:-:|:-:|:-:|105| No `/etc/hosts` editing | Yes | Yes | No |106| HTTPS with valid cert | Yes | No | Manual |107| Wildcard subdomains | Yes | No | No |108| Works in all browsers | Yes | Yes | Varies |109| Cookie isolation per service | Yes | No | Yes |110| No port conflicts | Yes | No | Yes |111112## Key Environment Variables113114When portless runs your command, it injects:115116| Variable | Value | Use in agents |117|----------|-------|---------------|118| `PORT` | Assigned ephemeral port (4000-4999) | Internal only |119| `HOST` | `127.0.0.1` | Internal only |120| `PORTLESS_URL` | `https://myapp.localhost` | **Use this in agent prompts** |121| `NODE_EXTRA_CA_CERTS` | Path to portless CA *(auto-injected 0.10.2)* | Child node processes trust portless certs without setup |122123### Toggle env vars124125| Variable | Effect |126|----------|--------|127| `PORTLESS=0` | Bypass portless entirely (CI) |128| `PORTLESS_SYNC_HOSTS=0` | Disable auto `/etc/hosts` sync (default: on in 0.10.1+) |129| `PORTLESS_STATE_DIR` | Override state dir (default: `~/.portless` or `/tmp/portless` for privileged ports) |130131## OrchestKit Integration Patterns132133### 1. Agent-Accessible Dev Server134135```bash136# Start with portless, then agents can target PORTLESS_URL137portless run npm run dev138139# In ork:expect or agent-browser:140agent-browser open $PORTLESS_URL141```142143### 2. Emulate + Portless (Named API Mocks)144145```bash146# Register emulate ports as named aliases147portless alias github-api 4001148portless alias vercel-api 4000149portless alias google-api 4002150151# Now agents can target:152# https://github-api.localhost — GitHub emulator153# https://vercel-api.localhost — Vercel emulator154```155156### 3. Git Worktree Dev157158```bash159# In worktree for feature/auth-flow:160portless run npm run dev161# → https://auth-flow.myapp.localhost (auto branch prefix)162```163164### 4. Bypass in CI165166```bash167# Disable portless in CI — direct port access168PORTLESS=0 npm run dev169```170171## Anti-Patterns172173| Don't | Do Instead |174|-------|------------|175| Hardcode `localhost:3000` in tests | Use `PORTLESS_URL` or `process.env.PORTLESS_URL` |176| Run portless in CI | Set `PORTLESS=0` in CI environments |177| Use numeric ports in AGENTS.md | Document the portless URL |178179## References180181| File | Content |182|------|---------|183| `references/upstream.md` | Full portless CLI reference (synced from Vercel) |184| `references/upstream-oauth.md` | OAuth callback patterns with stable URLs |185| `references/framework-integration.md` | Framework recipes (FastAPI, Django, Docker, gotchas) |186| `checklists/new-project-setup.md` | Step-by-step: add portless to a new project |