Open a wormhole to your localhost.
Expose your local server to a secure public URL in seconds. Share your work, demo to clients, or test webhooks—no deploy, no config.
Wormkey creates a secure tunnel from the internet to your local machine. Run your app on localhost, share a URL, and anyone can access it—without deploying, port forwarding, or VPNs.
- Instant — One command, one URL
- Secure — TLS-terminated, owner-controlled
- Simple — No accounts required for basic use
npm install -g wormkey
# or
npx wormkey http 3000# Start your local server (e.g. Next.js, Vite, etc.)
npm run dev
# In another terminal, open a wormhole
wormkey http 3000You'll get a shareable URL:
Tunnel ready.
Share:
https://wormkey.run/s/quiet-lime-82
Scan to open
[QR code]
Press L to open in browser | C to copy | P to pause / R to resume | Q to close
Share the first URL. Open the owner URL once to enable in-page controls when viewing through the tunnel.
Add to your app layout:
<script defer src="https://wormkey.run/.wormkey/overlay.js?slug=YOUR_SLUG"></script>When your app is viewed through the wormhole URL, a Wormkey control bar appears.
npm install wormkey// app/layout.tsx
import { WormkeyOverlay } from "wormkey";
export default function RootLayout({ children }) {
return (
<html>
<body>
{children}
<WormkeyOverlay slug={process.env.NEXT_PUBLIC_WORMKEY_SLUG} />
</body>
</html>
);
}npm install wormkey-overlayimport "wormkey-overlay/auto";<meta name="wormkey-overlay-url" content="https://wormkey.run/.wormkey/overlay.js?slug=YOUR_SLUG" />| Command | Description |
|---|---|
wormkey http <port> |
Expose a port via wormhole |
wormkey http 3000 --auth |
Require basic auth |
wormkey http 5173 --expires 30m |
Limit tunnel lifetime |
wormkey status |
Show active tunnel (URL, viewers, uptime) |
Interactive shortcuts (when tunnel is running): L open in browser · C copy URL · P pause · R resume · Q close
Run the full stack locally:
# Terminal 1: Control plane
cd packages/control-plane && npm install && npm run dev
# Terminal 2: Edge gateway (set WORMKEY_CONTROL_PLANE for local)
cd packages/gateway && WORMKEY_CONTROL_PLANE=http://localhost:3001 go run .
# Terminal 3: CLI (from repo root)
cd packages/cli && npm install && npm run build
wormkey http 3000| Component | Port | Role |
|---|---|---|
| CLI | — | Connects to Edge, forwards traffic to localhost |
| Control Plane | 3001 | Session creation, slug allocation |
| Edge Gateway | 3002 | TLS, routing, stream forwarding |
worm/
├── docs/
│ ├── PROTOCOL.md # Tunnel protocol specification
│ └── DEPLOY.md # Production deployment guide
├── packages/
│ ├── cli/ # wormkey npm package (Node/TypeScript)
│ ├── control-plane/ # Session API (Node/Fastify)
│ ├── gateway/ # Edge gateway (Go)
│ └── overlay/ # Overlay helpers (React, Express, auto)
├── website/ # wormkey.run (Next.js)
└── README.md
For local development, see .env.example. Key variables:
| Variable | Description |
|---|---|
WORMKEY_CONTROL_PLANE_URL |
Control plane API URL |
WORMKEY_EDGE_URL |
Edge gateway WebSocket URL (e.g. ws://localhost:3002/tunnel) |
- CLI Reference — Full command reference
- Wormkey for AI Agents — JSON mode, readiness, lifecycle management, inspection, replay, tokens, and MCP
- Protocol — Tunnel protocol specification
- Deploy — Production deployment (Render, Vercel)
MIT
Not a deploy platform. Not a hosting provider. Just a controlled wormhole.