Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dfanso/tunnel-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@dfanso/tunnel-client

A command-line tool to create secure WebSocket tunnels that expose your local servers to the internet. Perfect for development, testing, and sharing your local work.

Features

Create secure WebSocket tunnels to expose local servers
Custom subdomain support
Automatic port detection and management
Secure SSL/TLS connections
Easy-to-use CLI interface

Installation

npm install -g @dfanso/tunnel-client

Usage

Start a tunnel:

ltunnel start

You'll be prompted for:

Local port to tunnel
Desired subdomain (optional)
Tunnel server domain (defaults to dfanso.dev)
Tunnel server port (defaults to 8080)

Or specify options directly:

ltunnel start --port 3000 --subdomain myapp

Requirements

Node.js >= 14.0.0
A running local server to tunnel to

Configuration

The tunnel client connects to a WebSocket server at wss://dfanso.dev:8080 by default. You can configure a different server using the CLI prompts or command-line options.

Development

Clone the repository:

git clone https://github.com/dfanso/dfanso-tunnel-client.git
cd dfanso-tunnel-client

Install dependencies:

npm install

Run tests:

npm test

Start the client:

npm start

License

MIT

Author

dfanso