Skip to content

Establish an SSH forward tunnel. Highlight the tunnel info. Track the tunnel logs. Navigate them up and down.

Notifications You must be signed in to change notification settings

4l1fe/tunnel-runner

Repository files navigation

Description

The smart TUI for establishing an ssh tunnel.

Features:

  • CLI autocompletion from a config.
  • Highlighting tunnel addresses.
  • Navigation with a keyboard.
  • Resizing automatically with terminal or tmux panel size.

Dependencies

Usage

Create a config as described in the help text. Add as many sections [ssh_hosts], [targets] as you need to autocomplete.

$ run_tunnel.py --help 

   Config options
  --config        PATH  The `tunnel-runner.toml` config in the `XDG_CONFIG_HOME` or `HOME/.config` dir
                        Config pattern of the TOML format:
                    ```
                    [ssh_hosts."host.name"]  # A valid ssh_config `Host` value prefixed with `ssh_hosts`
                    description = "Helpful description to display in an autocompletion list."
    
                    [targets.service-name]  # An arbitrary name of valid TOML key prefixed with `targets`
                    local_address = "127.0.0.1"
                    local_port = 8080
                    remote_address = "127.0.0.1"
                    remote_port = 8080
                    description = "Helpful description to display in an autocompletion list."
                    
                    
                    [default: /home/user/.config/tunnel-runner.toml]

Run using autocompletion run_tunnel.py [TAB][TAB] [TAB][TAB]

$ run_tunnel.py miniserver.local docker-sock

Screenshots

  • Running

  • Autocompletion

  • Resizing

About

Establish an SSH forward tunnel. Highlight the tunnel info. Track the tunnel logs. Navigate them up and down.

Topics

Resources

Stars

Watchers

Forks

Languages