A simple & reliable command line SSH tunnel manager.
- Ultra lightweight and fast
- Local, remote and dynamic (SOCKS5) port forwarding
- Compatible with SSH config and
ssh-agent - Supports Unix sockets
- Automatic reconnection and keep-alives
- Human-friendly configuration via TOML
Usage:
boring l, list List tunnels
boring o, open <name1> [<name2> ...] Open specified tunnel(s)
boring c, close <name1> [<name2> ...] Close specified tunnel(s)
boring e, edit Edit configuration file
By default, boring reads its configuration from ~/.boring.toml on macOS and Windows, and from $XDG_CONFIG_HOME/boring/.boring.toml on Linux. If $XDG_CONFIG_HOME is not set, it defaults to ~/.config. The location of the config file can be overriden by setting $BORING_CONFIG. The config is a simple TOML file describing your tunnels:
# simple tunnel
[[tunnels]]
name = "dev"
local = "9000"
remote = "localhost:9000"
host = "dev-server" # automatically matches host against SSH config
# example of an explicit host (no SSH config)
[[tunnels]]
name = "prod"
local = "5001"
remote = "localhost:5001"
host = "prod.example.com"
user = "root"
identity = "~/.ssh/id_prod" # will try default ones if not set
# ... more tunnelsCurrently, supported options are:
name: Alias for the tunnel. Required.mode: Mode of the tunnel. Can be either "local", "remote", "socks" or "socks-remote", default is "local"local: Local address. Can be a "$host:$port" network address or a Unix socket. Can be abbreviated as "$port" in local and socks modes. Required in local, remote and socks modes.remote: Remote address. As above, but can be abbreviated in remote and socks-remote modes. Required in local, remote and socks-remote modes.host: Either a host alias which to match SSH configs to, or the actual hostname. Required.user: SSH user. If not set, tries to read it from SSH config, defaulting to$USER.identity: SSH identity file. If not set, tries to read it from SSH config andssh-agent, defaulting to the default files.port: SSH port. If not set, tries to read it from SSH config, defaulting to22.
brew install boring
Get one of the pre-built binaries from the releases page. Then move the binary to a location in your $PATH.
git clone https://github.com/alebeck/boring && cd boring
./build.shThen move the binary to a location in your $PATH.
Note for Windows users
Windows is fully supported since release 0.6.0. Users currently have to build from source, which is very easy. Make sure Go >= 1.23.0 is installed and then compile viagit clone https://github.com/alebeck/boring && cd boring
.\build_win.batThen, move the executable to a location in your %PATH%.