What is Wormkey?
Wormkey creates a secure tunnel from your localhost to a public URL in seconds. Perfect for:- Sharing your local development with clients or teammates
- Testing webhooks from external services
- Demoing features before deployment
- Mobile device testing on real URLs
Wormkey is not a deploy platform or hosting provider. It’s a controlled wormhole to your localhost.
Get started in 30 seconds
You’ll get a public URL like
https://wormkey.run/s/quiet-lime-82 that tunnels directly to your localhost.
Key features
Instant tunnels
Create a secure public URL to your localhost in seconds. No account or configuration required.
Basic authentication
Protect your tunnel with username and password authentication using the
--auth flag.Owner controls
Claim ownership of your tunnel to manage access and view connection status through a control bar.
React integration
Built-in React component and overlay helpers for seamless integration with Next.js and React apps.
Quick links
Quickstart
Get your first wormhole running in under a minute
Installation
Installation options for npm, yarn, and pnpm
CLI commands
Explore all available commands and options
React integration
Add the Wormkey overlay to your React app
How it works
Wormkey uses a lightweight protocol to create a WebSocket tunnel between your localhost and a public edge gateway:- The CLI connects to the control plane and requests a session
- You receive a unique slug (e.g.,
quiet-lime-82) and public URL - The CLI establishes a WebSocket tunnel to the edge gateway
- Incoming HTTP requests to your public URL are forwarded through the tunnel to your localhost
The tunnel stays open as long as the CLI is running. Press Ctrl+C to close the wormhole.
Architecture components
| Component | Role |
|---|---|
CLI (wormkey) | Connects to edge, forwards traffic to localhost |
| Control Plane | Session creation, slug allocation |
| Edge Gateway | TLS termination, routing, stream forwarding |
Learn more
Dive deep into the Wormkey architecture and protocol