vtunnel-cli

Create a secure tunnel to your local development server.

vtunnel allows you to expose your local development server to the internet through a secure tunnel, making it accessible from anywhere. Perfect for testing webhooks, sharing your work with clients, or accessing your local server from remote devices.

Installation

npm install -g vtunnel-cli

Usage

vtunnel expose --local-port <port>

Where <port> is the local port number (1-65535) you want to tunnel.

Examples

# Tunnel local port 3000
vtunnel expose --local-port 3000

# Tunnel local port 8080
vtunnel expose --local-port 8080

# Tunnel with custom tunnel server
vtunnel expose --local-port 3000 --tunnel-url http://my-tunnel-server:7000

# Tunnel with API key
vtunnel expose --local-port 3000 --api-key mykey123

After connecting to the tunnel server, you'll receive public HTTP and HTTPS URLs (using subdomain pattern app-{port}) that forward to your local server.

Command Options

• --local-port, -lp: Local port to tunnel (1-65535) [required]
• --api-key, -k: API key for authentication (default: "supersecret")
• --tunnel-url, -u: Tunnel server URL (default: "http://localhost:7000")

Features

• 🚀 Easy to use - Simple expose command with flexible options
• 🔒 Secure - All traffic is encrypted through tunnel server
• 🌐 Public URLs - Get a shareable URL for your local server
• 🎯 Port validation - Ensures valid port ranges (1-65535)
• 🔧 Configurable - API keys and tunnel servers
• 🛑 Graceful shutdown - Clean exit with Ctrl+C

Development

• Install dependencies:

npm install

• Run in development mode:

npm run dev expose --local-port <port>

• Run the unit tests:

npm test

• Build the project:

npm run build

• Type checking:

npm run typecheck

License

MIT

Repository

https://github.com/code-salad/vtunnel