bunnel
TypeScript icon, indicating that this package has built-in type declarations

0.1.6 • Public • Published

Bunnel Client

Installation

npm install bunnel
# or for global/CLI use
npm install -g bunnel

Usage

CLI

# Specify local server and tunnel server
bunnel client --local http://localhost:3000 --tunnel wss://example.com:4444

SDK

import { TunnelClient } from 'bunnel';

const tunnel = new TunnelClient({
    localServerUrl: 'http://localhost:3000',
    tunnelServerUrl: 'wss://example.com:4444',
    onClosed: () => console.log('Tunnel closed')
});

try {
    const { subdomain, tunnelUrl, proxyUrl } = await tunnel.connect();
    console.log(`Tunnel available on remote at: ${tunnelUrl} or ${proxyUrl}`);

    // Later, to disconnect
    tunnel.disconnect();
} catch (error) {
    console.error('Tunnel error:', error);
}

Options

  • --local, -l: Local server URL)
  • --tunnel, -t: Tunnel server URL)

Package Sidebar

Install

npm i bunnel

Weekly Downloads

415

Version

0.1.6

License

none

Unpacked Size

10.8 kB

Total Files

10

Last publish

Collaborators

  • anerli