Guide & Documentation

Usage Guide (macOS)

Once you have downloaded and installed the .pkg file for macOS, routelocal will be automatically available in your terminal path.

1. Open the Terminal application.

2. Run the command to expose your local port (replace 3000 with your port):

routelocal --port 3000 --name myapp

Usage Guide (Windows)

After downloading the Windows executable (routelocal-windows.exe):

1. It's recommended to rename the file to routelocal.exe and add its folder to your system's PATH variable, or simply run it from the downloaded folder.

2. Open Command Prompt or PowerShell.

3. Navigate to the folder containing the executable (or just run it if it's in your PATH):

.\routelocal.exe --port 3000 --name myapp

Commands Guide

Use the following sample commands to get the most out of RouteLocal. Click Copy to easily paste them into your terminal.

Expose to Local Network & mDNS

This exposes your local port so it's accessible via your local IP address and an mDNS hostname (e.g. myapp.local).

routelocal --port 5173 --name myapp

Expose to Public Internet

Use the --public flag to generate a secure Cloudflare tunnel URL accessible anywhere in the world.

routelocal --port 5173 --name myapp --public

Uninstalling Guide

macOS

To uninstall RouteLocal from macOS, remove the executable from your bin directory. Run the following command in your Terminal:

sudo rm /usr/local/bin/routelocal

Windows

To uninstall from Windows, simply delete the routelocal-windows.exe (or routelocal.exe) file from your computer. If you added its folder to your PATH variable, you can remove it from your Environment Variables settings.