localtunnels

A zero-config local tunnel that's simple, lightweight, and secure.

Features

• Simple, lightweight local tunnel
• Security built-in, including HTTPS
• IAC, self-hostable (via AWS)
• Custom subdomains
• CLI & Library

Install

bun install -d localtunnels

Get Started

There are two ways of using this local tunnel: as a library or as a CLI.

Library

Given the npm package is installed:

import type { LocalTunnelConfig } from 'localtunnels'
import { startLocalTunnel } from 'localtunnels'

const config: LocalTunnelConfig = {
  from: 'localhost:5173',
  domain: 'stacksjs.dev', // optional, defaults to the stacksjs.dev domain
  subdomain: 'test', // optional, uses a random subdomain by default
  verbose: true, // optional, defaults to false
}

startLocalTunnel(config)

You may als use a configuration file:

// tunnel.config.{ts,js}
import type { LocalTunnelConfig } from '@stacksjs/localtunnels'

const config: LocalTunnelConfig = {
  from: 'localhost:5173',
  domain: 'stacksjs.dev', // optional, defaults to the stacksjs.dev domain
  subdomain: 'test', // optional, uses a random subdomain by default
  verbose: true, // optional, defaults to false
}

export default config

Then run:

./localtunnels start

CLI

localtunnels start --from localhost:5173 --subdomain test --verbose
localtunnels --help
localtunnels --version

To learn more, head over to the documentation.

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please review the Contributing Guide for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where localtunnels is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

• JetBrains
• The Solana Foundation

Credits

• Chris Breuer
• All Contributors

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙