Get started

Quickstart

Login, connect one tunnel, and leave it running.

Before you begin

• Create a free Portwarp account.
• Create and enable at least one tunnel in the dashboard.
• Install the CLI using the guide for Windows, Linux, macOS, or Docker.
• Start your local application, game server, or service on the local port configured for the tunnel.

1. Sign in

pwrp login

The CLI opens a browser approval flow and displays a short code. Approve the device while leaving the command running. You do not enter your password in the terminal.

Optional: Enable remote control

Remote Control is an optional feature available only to PRO and Teams users. Enable it if you want this device to receive tunnel actions from the Portwarp dashboard, app, or API:

pwrp remote enable

You only need to enable it once on each device you want to control remotely. Check the current setting at any time with pwrp remote status.

2. Check your tunnels

pwrp tunnels

The list shows a number, name, protocol, local port, public port, and current state for each tunnel. You can select a tunnel later by its number, ID prefix, or exact name.

3. Connect

Interactive mode is the easiest first connection:

pwrp connect

Select one or more tunnels when prompted. The CLI starts its background daemon automatically and attaches your terminal to live logs.

Other selection forms

# Connect every enabled tunnel
pwrp connect --all

# Connect by row number, ID prefix, or exact name
pwrp connect 2
pwrp connect 6fc2dc65
pwrp connect "Minecraft Java"

# Connect several tunnels without attaching to logs
pwrp connect 1 3 "Minecraft Java" --detach

4. Detach without stopping

While attached, press Ctrl+C or type d to return to the shell. The tunnel continues in the background. Type stop while attached only when you want to end the tunnel.

5. Check the running session

pwrp ps
pwrp logs "Minecraft Java" -f
pwrp stats

pwrp ps shows connection state, local-service health, traffic, and uptime. Both ps and stats refresh automatically in an interactive terminal; add --once for scripts.

6. Make it persistent

Save the selection so the daemon knows which tunnels to reconnect, then enable startup on native installations:

pwrp connect --all --save --detach
pwrp service enable

In Docker, the container already starts the daemon. Use --save, a persistent volume, and a Compose restart policy instead of pwrp service enable.

Stop or restart

pwrp restart "Minecraft Java"
pwrp stop "Minecraft Java"
pwrp stop --all

Where to go next

Read the command reference for every command, or configure startup, notifications, and local targets in Configuration.