> For the complete documentation index, see [llms.txt](https://localxpose.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://localxpose.gitbook.io/docs/master.md).

# Getting Started

### Download

LocalXpose has two options, Command line (CLI) or Graphical User Interface (GUI), it is cross-platform (Linux, Windows, MacOS), you can download the suitable binary for your machine from the home page at <https://localxpose.io>.

### Regions

Currently the available regions that you can issue tunnels to are:

* United states
* Europe
* Asia Pacific
* *Australia (SOON)*

### Supported Tunnels

* HTTP/s
* TLS
* TCP
* UDP

### Supported platforms

* Linux
* Windows
* Mac

### Start your first tunnel

1. Signup from the home page [https://localxpose.io](https://localxpose.io/)
2. Verify your email address by clicking the `Verify` button in your email inbox.
3. Login to your dashboard by clicking `Login` button in the home page <https://localxpose.io>
4. Copy your access token that will be under `access` tab in your dashboard or go directly here <https://localxpose.io/dashboard/access>.
5. Download the CLI from the homepage.
6. This is a CLI app, you should start it from a terminal window (double click the app will not work), so for example in windows open your `cmd.exe` or `powershell` then navigate to your downloaded binary like `cd C:\Users\example` .
7. Login from CLI by calling:

```shell
# *nix operating systems 
loclx account login

# windows
loclx.exe account login
```

&#x20;  7\.  Start your tunnel

```shell
loclx tunnel http --to localhost:8080
```

You can change the `http` tunnel type to your needs like `tcp`, `tls` or `udp` and change `--to` to your localhost service, if your local server is running on port `80` then you should forward the traffic by doing `--to 80`, `localhost:80` , `http://localhost:80` or `:80`.

### Help

You can always refer to CLI help command, for instance if you need to know the options you have in the `http` tunnel, you can do `loclx tunnel http --help`, or if you need to know how to reserve a domain name you can do `loclx domain --help`.&#x20;

You are most welcome to reach us by email `hello@localxpose.io` or by clicking the chat button in our home page <https://localxpose.io>, or get help from other LocalXpose users <https://roadmap.localxpose.io>.