https://github.com/spikehd/fwd
Tiny CLI tool to expose localhost to LAN
https://github.com/spikehd/fwd
Last synced: 12 months ago
JSON representation
Tiny CLI tool to expose localhost to LAN
- Host: GitHub
- URL: https://github.com/spikehd/fwd
- Owner: SpikeHD
- License: mit
- Created: 2025-05-14T17:01:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-14T18:23:06.000Z (about 1 year ago)
- Last Synced: 2025-06-21T13:15:16.673Z (12 months ago)
- Language: Rust
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
fwd
Expose localhost ports to your local network
# Features
* Multithreaded
* Native ARM support
# Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [Building](#building)
* [Prerequisites](#prerequisites)
* [Steps](#steps)
* [TODO](#todo)
* [Contributions](#contributions)
## Installation
### Windows
```powershell
# Run the install script
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/SpikeHD/fwd/refs/heads/main/install.ps1" -OutFile "$env:TEMP\install.ps1"; PowerShell -ExecutionPolicy Bypass -File "$env:TEMP\install.ps1"
# You can uninstall by deleting C:\Program Files\fwd
del "C:\Program Files\fwd"
```
### Linux
```shell
# Run the install script
curl -fsSL https://raw.githubusercontent.com/SpikeHD/fwd/refs/heads/main/install.sh | sudo bash
# You can uninstall by removing the binary from /usr/local/bin
rm /usr/local/bin/fwd
```
### macOS
```shell
# Run the install script
curl -fsSL https://raw.githubusercontent.com/SpikeHD/fwd/refs/heads/main/install.sh | sudo bash
# You can uninstall by removing the binary from /usr/local/bin
rm /usr/local/bin/fwd
```
# Usage
> [!NOTE]
> You may need to add a firewall rule to allow incoming connections on the port you are forwarding to first!
```shell
# Get all options
fwd -h
# Forward connections to port 8080 from port 8081 (fwd will automatically expose to the local network if nothing is specified)
fwd 8080
# Forward connections to port 8080 from port 88001 on the local network
fwd 8080 -p 88001
```
## Building
### Prerequisites
* Rust
### Steps
1. Clone the repository
2. Run `cargo build --release`
3. The binary will be in `target/release/fwd`
## TODO
- [ ] Add support for UDP
- [ ] Multi-mapping (map multiple ports at once)
## Contributions
Issues, PRs, etc. are all welcome!