SSHTUNNEL(1)

💖 SSHTUNNEL(1) — the sshtunnel girlies' guide 💖

okay bestie, so this is the manual for sshtunnel, and it lives in the User Commands section of the manual pages. pull up a chair, grab a strawberry, and let's get into it ✨

---

🌸 NAME 🌸

sshtunnel — SSH tunnels to remote server 🦋

---

🎀 DESCRIPTION 🎀

here's the whole usage vibe, verbatim, no notes:

usage: sshtunnel [-h] [-U SSH_USERNAME] [-p SSH_PORT] [-P SSH_PASSWORD]
                 -R IP:PORT [IP:PORT ...] [-L [IP:PORT ...]] [-k SSH_HOST_KEY]
                 [-K KEY_FILE] [-S KEY_PASSWORD] [-t] [-v] [-V] [-x IP:PORT]
                 [-c SSH_CONFIG_FILE] [-z] [-n] [-d [FOLDER ...]] ssh_address

Pure python ssh tunnel utils, Version 0.1.4 👑

✨ positional arguments: ✨

• ssh_address — the SSH server IP address (that's your GW when you're doing SSH tunnels, iykyk). you set it with --ssh_address if it comes immediately after -R or -L. 💅

🌈 options: 🌈

• -h, --help — shows this help message and dips. iconic behaviour fr. 🙈
• -U SSH_USERNAME, --username SSH_USERNAME — the username for your SSH server account 🫶
• -p SSH_PORT, --server_port SSH_PORT — the SSH server TCP port (default: 22) 🍓
• -P SSH_PASSWORD, --password SSH_PASSWORD — the password for your SSH server account 🔐
• -R IP:PORT [IP:PORT ...], --remote_bind_address IP:PORT [IP:PORT ...] — remote bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n. it's equivalent to ssh -Lxxxx:IP_ADDRESS:PORT. if the port is omitted, it defaults to 22. example: -R 10.10.10.10: 10.10.10.10:5900 💖
• -L [IP:PORT ...], --local_bind_address [IP:PORT ...] — local bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n. the elements can also be valid UNIX socket domains: /tmp/foo.sock /tmp/bar.sock ... /tmp/baz.sock. equivalent to ssh -LPORT:xxxxxxxxx:xxxx, where the local IP address is optional. by default it will listen on all interfaces (0.0.0.0) and pick a random port — main character energy, honestly. example: -L :40000 🌸
• -k SSH_HOST_KEY, --ssh_host_key SSH_HOST_KEY — the gateway's host key 🔑
• -K KEY_FILE, --private_key_file KEY_FILE — the RSA/DSS/ECDSA private key file 🗝️
• -S KEY_PASSWORD, --private_key_password KEY_PASSWORD — the RSA/DSS/ECDSA private key password 🤫
• -t, --threaded — allow concurrent connections to each tunnel. multitasking queen 💅
• -v, --verbose — increase output verbosity (default: ERROR) 📢
• -V, --version — show the version number and quit 🏆
• -x IP:PORT, --proxy IP:PORT — the IP and port of the SSH proxy to the destination 🛰️
• -c SSH_CONFIG_FILE, --config SSH_CONFIG_FILE — the SSH configuration file, defaults to ~/.ssh/config 📁
• -z, --compress — ask the server for compression over the SSH transport 🗜️
• -n, --noagent — disables looking for keys from an SSH agent 🙅♀️
• -d [FOLDER ...], --host_pkey_directories [FOLDER ...] — a list of directories where SSH pkeys (in the format id_*) may be found 🔍

---

and that's the whole page, bestie — you ate that 💅✨

this was sshtunnel 0.1.4, from June 2022, and that's the vibe check, periodt. go make some tunnels, ily 🫶💖