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
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

ssh

package

Go to main page

Versions in this module

v0

v0.8.0

May 1, 2026

Changes in this version

type ConnectionParams

+ Command string

v0.7.0

Apr 21, 2026

Changes in this version

type ConnectionParams

+ Insecure bool

+ UseTLS bool

v0.6.0

Mar 6, 2026

Changes in this version

type ConnectionParams

+ Passphrase string

+ Password string

v0.5.2

Feb 15, 2026

v0.5.1

Feb 15, 2026

Changes in this version

+ func ReconstructCommand(pipeline *parser.Pipeline, isPSQL bool, toolkitPath bool) string

+ func ShellQuote(token string) string

+ func ValidHostKeyMode(mode string) bool

+ type Client interface

+ Close func() error

+ Execute func(ctx context.Context, command string, timeout time.Duration) (ExecResult, error)

+ SFTPSession func() (SFTPClient, error)

+ type ConnectionParams struct

+ Host string

+ IdentityFile string

+ Port int

+ User string

+ type Dialer interface

+ Dial func(ctx context.Context, params ConnectionParams) (Client, error)

+ type ExecResult struct

+ ExitCode int

+ RuntimeMs int

+ Stderr string

+ Stdout string

+ type HostKeyError struct

+ Message string

+ func (e *HostKeyError) Error() string

+ type HostKeyMode string

+ const HostKeyAcceptNew

+ const HostKeyOff

+ const HostKeyStrict

+ type ManagedConnection struct

+ Client Client

+ Params ConnectionParams

+ type Option func(*SSHManager)

+ func WithConnectTimeout(timeout time.Duration) Option

+ func WithHostKeyChecking(mode HostKeyMode) Option

+ func WithKnownHostsFile(path string) Option

+ func WithRetries(retries int) Option

+ func WithRetryBackoff(backoff time.Duration) Option

+ type SFTPClient interface

+ Chmod func(path string, mode os.FileMode) 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) (os.FileInfo, error)

+ type SSHManager struct

+ func NewSSHManager(dialer Dialer, opts ...Option) *SSHManager

+ func (m *SSHManager) Connect(ctx context.Context, params ConnectionParams) error

+ func (m *SSHManager) Connected() bool

+ func (m *SSHManager) Disconnect(_ context.Context, host string) error

+ func (m *SSHManager) Execute(ctx context.Context, host, command string, timeout time.Duration) (ExecResult, error)

+ func (m *SSHManager) ExecuteRaw(ctx context.Context, host, command string, timeout time.Duration) (ExecResult, error)

+ func (m *SSHManager) ResolveConnection(host string) (*ManagedConnection, error)

+ func (m *SSHManager) SFTPSession(host string) (SFTPClient, error)

+ type SystemSSHDialer struct

+ ControlDir string

+ func (d *SystemSSHDialer) CheckBinary() bool

+ func (d *SystemSSHDialer) Dial(ctx context.Context, params ConnectionParams) (Client, error)

+ type XCryptoDialer struct

+ ConnectTimeout time.Duration

+ HostKeyMode HostKeyMode

+ KnownHostsFile string

+ func (d *XCryptoDialer) Dial(ctx context.Context, params ConnectionParams) (Client, error)