Client Documentation
Overview of the Portr client CLI for creating HTTP, TCP, and WebSocket tunnels that expose your local services to the public internet.
The Portr client is a command-line tool that allows you to create secure tunnels from your local machine to the public internet.
Getting Started
Installation
Download and set up the Portr client on your machine.
Team Administration
Add users to teams and assign member or admin roles from the CLI.
HTTP Tunnels
Create HTTP tunnels with built-in request inspection.
Request Logs
Read locally stored HTTP request logs from the CLI.
Request Replay
Replay stored HTTP requests as-is or with edits.
App Server
Manage tunnels programmatically through a local HTTP API.
TCP Tunnels
Tunnel raw TCP connections for databases and other services.
Stub Tunnels
Serve templated responses without a separate local web server.
Static Tunnels
Serve a local directory on a public URL with no local web server.
WebSocket Tunnels
Enable real-time WebSocket connections through tunnels.
Advanced Features
Tunnel Templates
Set up reusable tunnel configurations for common services.
Doctor
Diagnose connection and configuration problems in one command.
Quick Commands
Here are the essential commands you'll use with the Portr client:
Getting Started with Portr
Learn what Portr is and how to get started with this self-hosted tunnel solution for exposing local HTTP, TCP, or WebSocket connections to the internet.
Client Installation
Install and configure the Portr client CLI on macOS, Linux, or Windows to start exposing local services through secure tunnels.