Client Documentation

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.

HTTP Tunnels

Create HTTP tunnels with built-in request inspection.

TCP Tunnels

Tunnel raw TCP connections for databases and other services.

WebSocket Tunnels

Enable real-time WebSocket connections through tunnels.

Advanced Features

Tunnel Templates

Set up reusable tunnel configurations for common services.

Quick Commands

Here are the essential commands you'll use with the Portr client:

# Set up authentication
portr auth set --token {your_token} --remote {your_domain}

# Create an HTTP tunnel
portr http 3000

# Create a TCP tunnel
portr tcp 5432

# Create tunnel with custom subdomain
portr http 3000 --subdomain my-app

# Start predefined tunnel templates
portr start my-service

# Get help
portr --help