Getting Started

Follow this guide to install ProxyLens and create your first public tunnel in under 3 minutes.

Prerequisites

Before installing, ensure you have Node.js installed on your machine.

$ node -v
v18.0.0 or higher recommended

Install the CLI globally via npm to access the `proxylens` command from anywhere.

bash

$ npm install -g node-proxylens

Tip: You can also run it without installing using npx node-proxylens.

Start your local server (e.g., on port 3000), then tell ProxyLens to expose it.

$ proxylens 3000

$ proxylens 3000 my-awesome-api

This will attempt to tunnel traffic from https://my-awesome-api.proxylens.dev to localhost:3000.

You should now see an output similar to this:

➜ Local: http://localhost:3000

➜ Remote: https://my-awesome-api.proxylens.dev

Waiting for requests...