CLI quickstart

Install Proxlane on Windows or Linux and publish your first local app

Install the Proxlane CLI, sign in with browser approval, check localhost, and create a public HTTPS URL on Windows or Linux.

Written and reviewed by: ProxlaneOperated by CloudruUpdated: 2026-10-03

CLI platforms

Windows / Linux

Desktop Launcher

Windows preview

Free

HTTP / TCP, 1 active tunnel

Before you start

Have a local app and account ready

Run a web app on port 3000 and confirm http://127.0.0.1:3000 opens on this computer. Use the same OS account for CLI login and background service setup. There is currently no macOS CLI or Launcher distribution.

Step by step

01
Install on Windows
Run these commands in PowerShell. The installer places the CLI on your path; open a new terminal if proxlane is not found. Windows Launcher is a separate graphical option.
```
irm https://proxlane.com/install.ps1 | iex
proxlane version
```
02
Or install on Linux
Use the Linux install script, then confirm the installed version. Choose the instructions for your operating system rather than running both installers.
```
curl -fsSL https://proxlane.com/install.sh | sh
proxlane version
```
03
Approve this device
Run login and complete the browser approval. The CLI saves a credential for this device; you do not need to copy a token into a command or chat. On an SSH host, use proxlane login --device and open its URL on another device.
```
proxlane login
proxlane doctor
```
04
Publish and verify the app
Check the local target, start the tunnel, and open the HTTPS URL printed by the CLI. Keep this terminal open while using a foreground tunnel. Ctrl+C stops it.
```
proxlane doctor http 3000
proxlane http 3000
```

Choose the correct protocol

Use HTTP for local web apps, APIs, OAuth callbacks, and webhooks. Use TCP for services such as SSH or Minecraft Java. UDP, including Minecraft Bedrock, requires Plus or Pro. Public HTTPS is terminated at the relay; the local web target in this guide uses HTTP. The TCP example below is for Java; for Bedrock, use proxlane udp 19132 instead in a separate terminal.

proxlane tcp 25565

Understand Free and stable endpoints

Free includes one active HTTP or TCP tunnel and 5 GB of monthly transfer. Its hostname or public port can change after a restart. Plus and Pro add UDP and reservations for HTTP hostnames, custom domains, and TCP/UDP ports. Reserve an endpoint in the Dashboard before requesting it from the CLI.

Share deliberately and stop when finished

A reachable public URL makes your app available outside your computer. Use a test app without private data for the first check, then add endpoint protection when sharing development work. Background profiles keep running when a terminal closes; a foreground command does not.

proxlane http --expires-in 30m 3000

Troubleshooting

Command not found

Open a new terminal after installing and check that the installation directory is on PATH. Confirm proxlane version works before registering MCP or starting a tunnel.

Browser approval does not complete

Use proxlane login --device on an SSH or headless host. Complete the new code in your own browser, then retry doctor; do not paste the saved credential into chat.

Local HTTP is unavailable

Confirm the app is running on the port printed by its development server. Test http://127.0.0.1:3000 before checking the public URL.

Frequently asked questions

Do I need to configure my router?

No inbound port-forwarding rule is needed. The local agent connects outward to the Proxlane relay.

Can I use macOS?

There is currently no supported macOS distribution. The CLI is available for Windows and Linux, and the Launcher preview is for Windows.

Proxlane