Versions in this module Expand all Collapse all v0 v0.2.0 Feb 10, 2026 v0.1.0 Feb 9, 2026 Changes in this version + func CreateSettings() settings.Settings + type Bastion struct + Host string + NoSession bool + Port string + User string + type Client struct + SessionSettings *session.Session + Settings settings.Settings + func NewClient(session *session.Session, privKeys []session.AgentPrivateKey) *Client + func (c *Client) AddCommandProvider(host string, f CommandProvider) *Client + func (c *Client) AddScriptProvider(host string, f UploadScriptProvider) *Client + func (c *Client) Check() connection.Check + func (c *Client) Command(name string, arg ...string) connection.Command + func (c *Client) File() connection.File + func (c *Client) IsStopped() bool + func (c *Client) KubeProxy() connection.KubeProxy + func (c *Client) Loop(fn connection.SSHLoopHandler) error + func (c *Client) OnlyPreparePrivateKeys() error + func (c *Client) PrivateKeys() []session.AgentPrivateKey + func (c *Client) RefreshPrivateKeys() error + func (c *Client) ReverseTunnel(address string) connection.ReverseTunnel + func (c *Client) Session() *session.Session + func (c *Client) SetFileProvider(host string, f FileProvider) *Client + func (c *Client) Start() error + func (c *Client) Stop() + func (c *Client) Tunnel(address string) connection.Tunnel + func (c *Client) UploadScript(scriptPath string, args ...string) connection.Script + func (c *Client) WithSettings(sett settings.Settings) *Client + type Command struct + func NewCommand(stdOut []byte) *Command + func (t *Command) Cmd(ctx context.Context) + func (t *Command) CombinedOutput(context.Context) ([]byte, error) + func (t *Command) OnCommandStart(fn func()) + func (t *Command) Output(context.Context) ([]byte, []byte, error) + func (t *Command) Run(ctx context.Context) error + func (t *Command) Start() error + func (t *Command) StderrBytes() []byte + func (t *Command) StdoutBytes() []byte + func (t *Command) Stop() + func (t *Command) Sudo(ctx context.Context) + func (t *Command) WithEnv(env map[string]string) + func (t *Command) WithErr(err error) *Command + func (t *Command) WithRun(f func()) *Command + func (t *Command) WithSSHArgs(args ...string) + func (t *Command) WithStdErr(s []byte) *Command + func (t *Command) WithStderrHandler(h func(line string)) + func (t *Command) WithStdoutHandler(h func(line string)) + func (t *Command) WithTimeout(timeout time.Duration) + type CommandProvider func(withBastion Bastion, scriptPath string, args ...string) *Command + type DownloadFn func(srcPath string) ([]byte, error) + type File struct + func NewFile(upload UploadFn, download DownloadFn) *File + func (f *File) Download(ctx context.Context, srcPath, dstPath string) error + func (f *File) DownloadBytes(ctx context.Context, remotePath string) ([]byte, error) + func (f *File) Upload(ctx context.Context, srcPath, dstPath string) error + func (f *File) UploadBytes(ctx context.Context, data []byte, remotePath string) error + type FileProvider func(bastion Bastion) *File + type SSHProvider struct + func NewSSHProvider(initSession *session.Session, once bool) *SSHProvider + func (p *SSHProvider) AddCommandProvider(host string, f CommandProvider) *SSHProvider + func (p *SSHProvider) AddScriptProvider(host string, f UploadScriptProvider) *SSHProvider + func (p *SSHProvider) Cleanup(context.Context) error + func (p *SSHProvider) Client(context.Context) (connection.SSHClient, error) + func (p *SSHProvider) InitSession() *session.Session + func (p *SSHProvider) NewAdditionalClient(context.Context) (connection.SSHClient, error) + func (p *SSHProvider) NewStandaloneClient(ctx context.Context, sess *session.Session, ...) (connection.SSHClient, error) + func (p *SSHProvider) SetFileProvider(host string, f FileProvider) *SSHProvider + func (p *SSHProvider) SwitchClient(_ context.Context, sess *session.Session, ...) (connection.SSHClient, error) + func (p *SSHProvider) SwitchToDefault(ctx context.Context) (connection.SSHClient, error) + func (p *SSHProvider) Switches() []Switch + func (p *SSHProvider) WithInitPrivateKeys(k []session.AgentPrivateKey) *SSHProvider + func (p *SSHProvider) WithSwitchHandler(f SwitchHandler) *SSHProvider + type Script struct + func NewScript(stdOut []byte) *Script + func (t *Script) Execute(context.Context) ([]byte, error) + func (t *Script) ExecuteBundle(ctx context.Context, parentDir, bundleDir string) ([]byte, error) + func (t *Script) Sudo() + func (t *Script) WithBundlerOpts(opts ...connection.BundlerOption) + func (t *Script) WithCleanupAfterExec(doCleanup bool) + func (t *Script) WithEnvs(envs map[string]string) + func (t *Script) WithError(err error) *Script + func (t *Script) WithExecuteUploadDir(dir string) + func (t *Script) WithNoLogStepOutOnError(enabled bool) + func (t *Script) WithRun(f func()) *Script + func (t *Script) WithStdoutHandler(handler func(string)) + func (t *Script) WithTimeout(timeout time.Duration) + type Switch struct + Bastion Bastion + PrivateKeys []session.AgentPrivateKey + Session *session.Session + type SwitchHandler func(s Switch) + type UploadFn func(data []byte, dstPath string) error + type UploadScriptProvider func(withBastion Bastion, scriptPath string, args ...string) *Script
Go to main page