# `tunnelto`
`tunnelto` lets you expose your locally running web server via a public URL.
Written in Rust. Built completely with async-io on top of tokio.
1. [Install](#install)
2. [Usage Instructions](#usage)
3. [Host it yourself](#host-it-yourself)
# Install
## Brew (macOS)
```bash
brew install agrinman/tap/tunnelto
```
## Cargo
```bash
cargo install tunnelto
```
## Everywhere
Or **Download a release for your target OS here**: [tunnelto/releases](https://github.com/tunneltodev/tunnelto/releases)
# Usage
## Quick Start
```shell script
tunnelto --port 8000
```
The above command opens a tunnel and forwards traffic to `localhost:8000`.
## More Options:
```shell script
tunnelto 0.1.20
USAGE:
tunnelto [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose A level of verbosity, and can be used multiple times
OPTIONS:
--dashboard-address Sets the address of the local introspection dashboard
-k, --key Sets an API authentication key to use for this tunnel
--host
Sets the HOST (i.e. localhost) to forward incoming tunnel traffic to [default: localhost]
-p, --port
Sets the port to forward incoming tunnel traffic to on the target host
--scheme
Sets the SCHEME (i.e. http or https) to forward incoming tunnel traffic to [default: http]
-s, --subdomain Specify a sub-domain for this tunnel
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
set-auth Store the API Authentication key
```