Documentation
Everything you need to know about PreviewBox — from your first tunnel to the full API.
PreviewBox gives every developer a public URL for their local machine. Run prevbox serve http 3000 in your terminal and your local dev server is instantly reachable at https://your-tunnel.previewbox.dev — with HTTPS, custom subdomains, live request logs, and a full dashboard for monitoring and debugging.
It works with anything that listens on a port: web apps, APIs, webhook consumers, and — with TCP tunnels — even non-HTTP services like Minecraft servers.
Start here
Install the CLI, authenticate, and share your first localhost URL in under a minute.
Public HTTPS URLs for local web servers, custom subdomains, and multiple simultaneous tunnels.
Raw TCP forwarding for non-HTTP services — game servers like Minecraft, SSH, databases and more.
Every command, TUI page, keyboard shortcut and config file in the prevbox CLI.
Manage tunnels, watch analytics, record and replay traffic, monitor uptime, and manage your team.
Receive tunnel and request events as HTTP callbacks, with HMAC signature verification.
The PreviewBox REST API — authentication, endpoints for tunnels, analytics, webhooks and more.
Common questions about pricing, HTTPS, custom subdomains, game servers and account security.
Quick start
Install the CLI (requires Node.js 18 or later), then share a local server:
npm install -g prevbox
# start a tunnel to localhost:3000
prevbox serve http 3000
# you'll get a URL like https://happy-fox-42.previewbox.devWant more detail? Read the Getting Started guide, or jump to the CLI reference.