expose localhost to the world

1.9.2  •  Published 6 months ago  •  by localtunnel  •  MIT License

Build Status

localtunnel exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes.

Great for working with browser testing tools like browserling or external api callback services like twilio which require a public url for callbacks.


npm install -g localtunnel

This will install the localtunnel module globally and add the ‘lt’ client cli tool to your PATH.


Assuming your local server is running on port 8000, just use the lt command to start the tunnel.

lt --port 8000

Thats it! It will connect to the tunnel server, setup the tunnel, and tell you what url to use for your testing. This url will remain active for the duration of your session; so feel free to share it with others for happy fun time!

You can restart your local server all you want, lt is smart enough to detect this and reconnect once it is back.


Below are some common arguments. See lt --help for additional arguments

  • --subdomain request a named subdomain on the localtunnel server (default is random characters)
  • --local-host proxy to a hostname other than localhost

You may also specify arguments via env variables. E.x.

PORT=3000 lt


The localtunnel client is also usable through an API (for test integration, automation, etc)

localtunnel(port [,opts], fn)

Creates a new localtunnel to the specified local port. fn will be called once you have been assigned a public localtunnel url. opts can be used to request a specific subdomain.

var localtunnel = require('localtunnel');

var tunnel = localtunnel(port, function(err, tunnel) {
    if (err) ...

    // the assigned public url for your tunnel
    // i.e. https://abcdefgjhij.localtunnel.me

tunnel.on('close', function() {
    // tunnels are closed


  • subdomain A string value requesting a specific subdomain on the proxy server. Note You may not actually receive this name depending on availability.
  • local_host Proxy to this hostname instead of localhost. This will also cause the Host header to be re-written to this value in proxied requests.


The tunnel instance returned to your callback emits the following events

event args description
request info fires when a request is processed by the tunnel, contains method and path fields
error err fires when an error happens on the tunnel
close fires when the tunnel has closed

The tunnel instance has the following methods

method args description
close close the tunnel

other clients

Clients in other languages

go gotunnelme

go go-localtunnel


See localtunnel/server for details on the server that powers localtunnel.



How do you feel about the name Devstore for this site?


Weekly Downloads



Last ver 6 months ago
Created 7 years ago
Last commit 3 months ago
17 days between commits


Node version: 12.1.0
21.7K unpacked


MIT License
OSI Approved
0 vulnerabilities


29 contributors
Roman Shtylman
Maintainer, 126 commits, 27 merges
Omri Bahumi
5 commits
Tymoteusz Paszun
2 commits, 1 PRs
Andrii Shumada
1 commits, 1 PRs
Works at Everad
Adam Mckaig
1 commits, 1 PRs
Works at Google
Fredi Pevcin
1 commits, 1 PRs
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things