Documentation

Learn how to use wsgrok to create secure tunnels to your local development environment

Getting Started

Install wsgrok client using one of the following methods:

Linux / macOS

curl -sSL https://wsgrok.com/install.sh | bash

Windows (PowerShell)

iwr https://wsgrok.com/install.ps1 | iex

Manual Download

Visit the Download page to download binaries for your platform.

Before using wsgrok, you need to authenticate with your account:

wsgrok --auth

Paste your token when prompted. Your credentials will be securely stored in ~/.wsgrok/credentials

Once authenticated, you can create a tunnel with a simple command:

wsgrok <port> <subdomain>

Example:

wsgrok 3000 myapp

This will create a tunnel from https://myapp.wsgrok.com to your local service running on port 3000.

You can also use flags:

wsgrok -port 3000 -subdomain myapp

Custom Client ID

wsgrok 3000 myapp -client-id my-custom-id

Specify a custom client identifier (auto-generated by default)

Multiple Connections

wsgrok 3000 myapp -connections 4

Use multiple parallel connections (1-4) for better performance (default: 2)

Configure your tunnels through the tunnel manager:

Visit the Tunnels to manage your tunnel settings.

Monitor and debug HTTP traffic in real-time using the HTTP Inspector:

Visit the HTTP Inspector to start monitoring your tunnels.

Authentication Errors

If you see authentication errors, refresh your credentials:

wsgrok --auth

Connection Issues

Ensure your local service is running and accessible on the specified port.

Subdomain Already in Use

Choose a different subdomain or delete the existing tunnel from the management console.

If you encounter any issues or have questions: