Skip to content
This repository has been archived by the owner. It is now read-only.
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 

wormhole

A simple package for establishing an SSH tunnel for local development

Usage

Set the environment variables:

  • WORMHOLE_REMOTE_HOST - the remote host you are connecting to
  • WORMHOLE_REMOTE_PORT - the remote port assigned to you by the host

Import the module establish a connection exposing port 3000:

const wormhole = require('wormhole')

wormhole.connect(3000, (err, url) => {
  if (err) {
    throw err
  }

  console.log(`Your URL is: ${url}`)
})

CLI Usage

This module can also be used via the CLI, like so:

WORMHOLE_REMOTE_HOST='...' \
WORMHOLE_REMOTE_PORT=... \
wormhole 3000

About

SSH tunnel for local development

Resources

License

Releases

No releases published

Packages

No packages published