ssh

Documentation

Overview

Package ssh provides kool ssh utilities (local port forward, etc.).

Index

• func BuildSSHForwardArgv(localPort int, remoteHost string, remotePort int, sshHost string) []string
• func Handle(args []string) error
• func HandleWith(args []string, opts HandleOpts) error
• type HandleOpts

Functions

func BuildSSHForwardArgv

func BuildSSHForwardArgv(localPort int, remoteHost string, remotePort int, sshHost string) []string

BuildSSHForwardArgv returns ssh args after the binary name for a local forward.

func Handle

func Handle(args []string) error

Handle is the production entry for kool ssh.

func HandleWith

func HandleWith(args []string, opts HandleOpts) error

HandleWith is the injectable entry used by tests.

Types

type HandleOpts

type HandleOpts struct {
	Stdout io.Writer
	Stderr io.Writer
	// RunSSH runs the ssh process and blocks until exit. Nil → real exec.
	// argv is the full argument list after "ssh" (not including binary name).
	RunSSH func(argv []string) error
	// WaitLocalReady waits until localPort accepts TCP. Nil → default dial loop.
	WaitLocalReady func(localPort int, timeout time.Duration) error
}

HandleOpts injects IO and process runner for tests.