From d9ec7efaae686a4ef6b1444defa422977cd1578f Mon Sep 17 00:00:00 2001 From: Menno van Leeuwen Date: Fri, 23 May 2025 15:16:47 +0200 Subject: [PATCH] Update CLI flags and repository URLs --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index bfc3fd7..46dce74 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ A Go-based command-line tool to manage SSH tunnels. This tool allows you to: ## 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: ``` -git clone https://github.com/yourusername/sshtunnel.git +git clone https://git.mvl.sh/vleeuwenmenno/sshtunnel.git cd sshtunnel 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 ``` -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: -- `-local`: Local port to forward (required) -- `-remote`: Remote port to forward to (required) -- `-host`: Remote host to forward to (default: "localhost") -- `-server`: SSH server address in the format user@host (required) -- `-identity`: Path to SSH identity file (optional) +- `-l`: Local port to forward (required) +- `-r`: Remote port to forward to (required) +- `-H`: Remote host to forward to (default: "localhost") +- `-s`: SSH server address in the format user@host (required) +- `-i`: Path to SSH identity file (optional) ### Stopping tunnels Stop a specific tunnel by ID: ``` -sshtunnel stop -id 1 +sshtunnel stop -i 1 ``` Stop all active tunnels: ``` -sshtunnel stop -all +sshtunnel stop --all ``` Options: -- `-id`: ID of the tunnel to stop -- `-all`: Stop all tunnels +- `-i`: ID of the tunnel to stop +- `--all`: Stop all tunnels ### Viewing traffic statistics @@ -69,12 +69,12 @@ sshtunnel stats --all View statistics for a specific tunnel: ``` -sshtunnel stats --id 1 +sshtunnel stats -i 1 ``` Monitor tunnel traffic in real-time: ``` -sshtunnel stats --id 1 --watch +sshtunnel stats -i 1 --watch ``` Options: @@ -107,4 +107,4 @@ The tool creates SSH tunnels using the system's SSH client and manages them by t ## License -MIT \ No newline at end of file +MIT