vleeuwenmenno/sshtunnel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CLI flags and repository URLs

Browse Source
This commit is contained in:
Menno van Leeuwen 2025-05-23 15:16:47 +02:00
parent e602d503e8
commit d9ec7efaae
Signed by: vleeuwenmenno
SSH Key Fingerprint: SHA256:OJFmjANpakwD3F2Rsws4GLtbdz1TJ5tkQF0RZmF0TRE
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -10,13 +10,13 @@ A Go-based command-line tool to manage SSH tunnels. This tool allows you to:
## Installation ## Installation
``` ```
go install github.com/yourusername/sshtunnel/cmd@latest go install git.mvl.sh/vleeuwenmenno/sshtunnel/cmd@latest
``` ```
Or clone this repository and build it yourself: Or clone this repository and build it yourself:
``` ```
git clone https://github.com/yourusername/sshtunnel.git git clone https://git.mvl.sh/vleeuwenmenno/sshtunnel.git
cd sshtunnel cd sshtunnel
go build -o sshtunnel ./cmd go build -o sshtunnel ./cmd
``` ```
@ -34,31 +34,31 @@ This will display all active SSH tunnels with their IDs, local ports, remote end
### Starting a new tunnel ### Starting a new tunnel
``` ```
sshtunnel start -local 8080 -remote 80 -host example.com -server user@ssh-server.com sshtunnel start -l 8080 -r 80 -H example.com -s user@ssh-server.com
``` ```
Options: Options:
- `-local`: Local port to forward (required) - `-l`: Local port to forward (required)
- `-remote`: Remote port to forward to (required) - `-r`: Remote port to forward to (required)
- `-host`: Remote host to forward to (default: "localhost") - `-H`: Remote host to forward to (default: "localhost")
- `-server`: SSH server address in the format user@host (required) - `-s`: SSH server address in the format user@host (required)
- `-identity`: Path to SSH identity file (optional) - `-i`: Path to SSH identity file (optional)
### Stopping tunnels ### Stopping tunnels
Stop a specific tunnel by ID: Stop a specific tunnel by ID:
``` ```
sshtunnel stop -id 1 sshtunnel stop -i 1
``` ```
Stop all active tunnels: Stop all active tunnels:
``` ```
sshtunnel stop -all sshtunnel stop --all
``` ```
Options: Options:
- `-id`: ID of the tunnel to stop - `-i`: ID of the tunnel to stop
- `-all`: Stop all tunnels - `--all`: Stop all tunnels
### Viewing traffic statistics ### Viewing traffic statistics
@ -69,12 +69,12 @@ sshtunnel stats --all
View statistics for a specific tunnel: View statistics for a specific tunnel:
``` ```
sshtunnel stats --id 1 sshtunnel stats -i 1
``` ```
Monitor tunnel traffic in real-time: Monitor tunnel traffic in real-time:
``` ```
sshtunnel stats --id 1 --watch sshtunnel stats -i 1 --watch
``` ```
Options: Options: