Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sshrunner

package

Go to main page

Versions in this module

v0

v0.1.5

Sep 9, 2026

Changes in this version

type Result

+ func Exited(argv []string, running Session) (*Result, error)

v0.1.4

Sep 3, 2026

Changes in this version

type Result

+ func Stream(ctx context.Context, runner Runner, argv ...string) (*Result, error)

type Runner

+ Ping func(ctx context.Context) error

v0.1.3

Aug 31, 2026

v0.1.2

Aug 27, 2026

v0.1.1

Aug 27, 2026

Changes in this version

+ var ErrExecNotFound = errors.New("exec not found")

+ func ExitError(argv []string, res *Result) error

+ func NewClientConfig(cfg coretypes.SSHConfig, user string, timeout time.Duration) (*ssh.ClientConfig, error)

+ func NodeInfo(ctx context.Context, runner Runner, root string) (*enginetypes.Info, error)

+ func ParseEndpoint(endpoint, prefix string) (user, host, addr string, err error)

+ func Quote(argv []string) string

+ func Reader(sess Session) io.ReadCloser

+ func Shell(body string, args ...string) []string

+ type Execs struct

+ func NewExecs() *Execs

+ func (e *Execs) Add(execID string, sess Session)

+ func (e *Execs) ExitCode(execID string) (int, error)

+ func (e *Execs) Resize(execID string, height, width uint) error

+ type FileInfo struct

+ GID int

+ Mode os.FileMode

+ UID int

+ type Files interface

+ Chmod func(path string, mode os.FileMode) error

+ Chown func(path string, uid, gid int) error

+ Close func() error

+ Create func(path string) (io.WriteCloser, error)

+ MkdirAll func(path string) error

+ Open func(path string) (io.ReadCloser, error)

+ Stat func(path string) (*FileInfo, error)

+ type Result struct

+ Code int

+ Stderr string

+ Stdout string

+ func Call(ctx context.Context, runner Runner, argv ...string) (*Result, error)

+ func Run(ctx context.Context, runner Runner, argv ...string) (*Result, error)

+ type Runner interface

+ Close func() error

+ Dial func(ctx context.Context, network, addr string) (net.Conn, error)

+ Files func(ctx context.Context) (Files, error)

+ Run func(ctx context.Context, line string, stdin io.Reader) (*Result, error)

+ Start func(ctx context.Context, line string, opts *StartOptions) (Session, error)

+ func New(addr string, config *ssh.ClientConfig) Runner

+ type Session interface

+ Close func() error

+ Resize func(height, width uint) error

+ Stderr func() io.ReadCloser

+ Stdin func() io.WriteCloser

+ Stdout func() io.ReadCloser

+ Wait func() (int, error)

+ type StartOptions struct

+ Stdin bool

+ TTY bool