@hongminhee/localtunnel

localtunnel

This package is a simple wrapper around the local tunneling services. Currently it supports localhost.run, serveo.net, and Pinggy. The module is designed to be simple to use and to provide a consistent interface to those services.

Installation

It is available on JSR and npm:

deno add --jsr @hongminhee/localtunnel  # Deno
npm  add       @hongminhee/localtunnel  # npm
pnpm add       @hongminhee/localtunnel  # pnpm
yarn add       @hongminhee/localtunnel  # Yarn
bun  add       @hongminhee/localtunnel  # Bun

Usage

Invoke the openTunnel() function to open a tunnel to a local port. The function returns a promise that resolves to a Tunnel object. The Tunnel object has a url property that contains the URL of the tunnel. The Tunnel object also has a close() method that closes the tunnel:

const tunnel = await openTunnel({ port: 8000 });
console.log(tunnel.url.href);
alert("Press Enter to close the tunnel.");
await tunnel.close();

For more information, see the API documentation.

Changelog

Version 0.3.0

Released on August 31, 2025.

• Added support for Node.js and Bun.
• The package is now published on npm as well as JSR.
• Every field in Service, Tunnel, and TunnelOptions is now readonly.
• Added extraOptions and extraArgs fields to the Service interface.
• Added "pinggy.io" to the ServiceName type. [#1]

Version 0.2.0

Released on April 29, 2024.

• Added exclude option to TunnelOptions interface.
• Now openTunnel() automatically retries with another service if the first service fails.

Version 0.1.1

Released on April 28, 2024.

• Fixed a bug in openTunnel() that breaks standard input on Windows.
• Improved error handling in openTunnel().
• Added log messages using LogTape. The log category is ["localtunnel"].

Version 0.1.0

Initial release. Released on April 26, 2024.