ssh

Jun 16, 2026

Changes in this version

type Client

+ func (c *Client) Socks5Forward(ctx context.Context, listenAddr string) error

+ type LockedWriter struct

+ func NewLockedWriter(mu *sync.Mutex, w io.Writer) *LockedWriter

+ func (lw *LockedWriter) Write(p []byte) (n int, err error)

+ type OutputMode int

+ const OutputModeFile

+ const OutputModeRingBuffer

+ const OutputModeStream

+ const OutputModeString

type RunConfig

+ OutFile *os.File

+ OutMode OutputMode

+ RingMaxBytes int

+ StreamPrefix string

+ StreamWriter io.Writer

type RunOption

+ func WithOutFile(file *os.File) RunOption

+ func WithOutputMode(mode OutputMode) RunOption

+ func WithRingBuffer(maxBytes int) RunOption

+ func WithStream(writer io.Writer, prefix string) RunOption

May 30, 2026

Changes in this version

+ const DefaultPasswordPromptPattern

+ func StaticRespond(s string) func() (string, error)

type Client

+ func (c *Client) Config() *ClientConfig

+ type ClientConfig struct

+ Address string

+ AuthType string

+ KeyPath string

+ NodeID string

+ Passphrase string

+ Password string

+ PasswordPromptPattern string

+ Port int

+ ProxyJump string

+ SuPwd string

+ SudoMode SudoMode

+ User string

+ type ConfigStore interface

+ GetConfig func(nodeID string) (*ClientConfig, error)

+ UpdateAuth func(nodeID string, password, keyPath, passphrase string) error

+ UpdateSudo func(nodeID string, mode SudoMode, suPwd string) error

type Connector

+ AcceptNewHostKey atomic.Bool

+ PasswordPromptPattern string

+ type Expect struct

+ Target io.Writer

+ func NewExpect(writer io.Writer, rules ...ExpectRule) *Expect

+ func (e *Expect) CleanOutput(promptPattern *regexp.Regexp) string

+ func (e *Expect) Output() string

+ func (e *Expect) SetAccumulate(acc bool)

+ func (e *Expect) SetTarget(target io.Writer)

+ func (e *Expect) Stop()

+ func (e *Expect) Wait(ctx context.Context, timeout time.Duration) error

+ func (e *Expect) Write(p []byte) (n int, err error)

+ type ExpectRule struct

+ Pattern *regexp.Regexp

+ Respond func() (string, error)

+ type InteractionHandler interface

+ ConfirmHostKey func(hostname string, fingerprint string) (bool, error)

+ PromptPassword func(prompt string) (string, error)

+ type RunConfig struct

+ LoginShell bool

+ func DefaultRunConfig() *RunConfig

+ type RunOption func(*RunConfig)

+ func WithLoginShell(login bool) RunOption

+ type SudoMode string

+ const SudoModeAuto

+ const SudoModeNone

+ const SudoModeRoot

+ const SudoModeSu

+ const SudoModeSudo

+ const SudoModeSudoer

May 22, 2026

Changes in this version

+ type CPUTicks struct

+ Idle uint64

+ Iowait uint64

+ Irq uint64

+ Nice uint64

+ Softirq uint64

+ Steal uint64

+ Sys uint64

+ User uint64

+ func (t *CPUTicks) IdleTicks() uint64

+ func (t *CPUTicks) Total() uint64

type Client

+ func (c *Client) RunStream(ctx context.Context, cmd string) (io.ReadCloser, error)

+ type DiskMetric struct

+ MountPoint string

+ Total uint64

+ Usage float64

+ Used uint64

+ type MetricsCollector struct

+ SortAsc bool

+ SortBy string

+ func NewMetricsCollector(c *Client) *MetricsCollector

+ func (mc *MetricsCollector) Close()

+ func (mc *MetricsCollector) NextFrame(ctx context.Context) (*SystemMetrics, error)

+ func (mc *MetricsCollector) Start(ctx context.Context) error

+ type SystemMetrics struct

+ CPUUsage float64

+ Cores int

+ Disks []DiskMetric

+ LoadAverage string

+ MemTotal uint64

+ MemUsage float64

+ MemUsed uint64

+ TopProcesses []string

+ Uptime string

Apr 3, 2026

Changes in this version

type Client

+ func (c *Client) RunInteractiveCmd(ctx context.Context, cmd string) error

Mar 30, 2026

Changes in this version

+ func BuildAutoAuthMethods(user, host string, passwordCallback func(string)) ([]ssh.AuthMethod, func())

type Client

+ func (c *Client) LocalForward(ctx context.Context, localAddr, remoteAddr string) error

+ func (c *Client) RemoteForward(ctx context.Context, remoteAddr, localAddr string) error

Mar 20, 2026

Changes in this version

type Client

+ func (c *Client) RunInteractive(ctx context.Context, cmd string) error

+ func (c *Client) RunInteractiveWithSudo(ctx context.Context, command string) error

Mar 13, 2026

Changes in this version

+ func StartKeepAlive(client *ssh.Client, interval time.Duration, fallback func(err error))

+ type AuthMethod interface

+ GetMethod func() (ssh.AuthMethod, error)

+ type Client struct

+ func (c *Client) Close() error

+ func (c *Client) Node() models.Node

+ func (c *Client) Run(ctx context.Context, cmd string) (string, error)

+ func (c *Client) RunScript(ctx context.Context, scriptContent string) (string, error)

+ func (c *Client) RunScriptWithSudo(ctx context.Context, scriptContent string) (string, error)

+ func (c *Client) RunWithSudo(ctx context.Context, command string) (string, error)

+ func (c *Client) RunWithoutLogin(ctx context.Context, cmd string) (string, error)

+ func (c *Client) SSHClient() *ssh.Client

+ func (c *Client) Shell(ctx context.Context) error

+ func (c *Client) ShellWithSudo(ctx context.Context) error

+ type Connector struct

+ Config config.ConfigProvider

+ func NewConnector(cfg config.ConfigProvider) *Connector

+ func (c *Connector) CloseAll()

+ func (c *Connector) Connect(ctx context.Context, nodeName string) (*Client, error)

+ type Dialer interface

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

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

+ type KeyAuth struct

+ Passphrase string

+ Path string

+ func (k *KeyAuth) GetMethod() (ssh.AuthMethod, error)

+ type PasswordAuth struct

+ Password string

+ func (p *PasswordAuth) GetMethod() (ssh.AuthMethod, error)

+ type SSHProxyDialer struct

+ Client *ssh.Client

+ func (s *SSHProxyDialer) Dial(network, addr string) (net.Conn, error)

+ func (s *SSHProxyDialer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)