remote

Documentation

Index

• func ConnectToClient(connCtx context.Context, opts *SSHOpts) (*ssh.Client, error)
• func CpHostToRemote(client *ssh.Client, sourcePath string, destPath string) error
• func DetectShell(client *ssh.Client) (string, error)
• func DialContext(ctx context.Context, network string, addr string, config *ssh.ClientConfig) (*ssh.Client, error)
• func GetClientArch(client *ssh.Client) (string, error)
• func GetClientOs(client *ssh.Client) (string, error)
• func GetHomeDir(client *ssh.Client) string
• func GetWshPath(client *ssh.Client) string
• func GetWshVersion(client *ssh.Client) (string, error)
• func InstallClientRcFiles(client *ssh.Client) error
• func IsPowershell(shellPath string) bool
• func NormalizeConfigPattern(pattern string) string
• type HostKeyAlgorithms
• type SSHOpts
  • func ParseOpts(input string) (*SSHOpts, error)
  • func (opts SSHOpts) String() string
• type SshKeywords
• type UserInputCancelError
  • func (uice UserInputCancelError) Error() string

Functions

func ConnectToClient

func ConnectToClient(connCtx context.Context, opts *SSHOpts) (*ssh.Client, error)

func CpHostToRemote

func CpHostToRemote(client *ssh.Client, sourcePath string, destPath string) error

func DetectShell

func DetectShell(client *ssh.Client) (string, error)

func DialContext

func DialContext(ctx context.Context, network string, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

func GetClientArch

func GetClientArch(client *ssh.Client) (string, error)

func GetClientOs

func GetClientOs(client *ssh.Client) (string, error)

func GetHomeDir

func GetHomeDir(client *ssh.Client) string

func GetWshPath

func GetWshPath(client *ssh.Client) string

func GetWshVersion

func GetWshVersion(client *ssh.Client) (string, error)

func InstallClientRcFiles

func InstallClientRcFiles(client *ssh.Client) error

func IsPowershell

func IsPowershell(shellPath string) bool

func NormalizeConfigPattern

func NormalizeConfigPattern(pattern string) string

Types

type HostKeyAlgorithms

type HostKeyAlgorithms = func(hostWithPort string) (algos []string)

type SSHOpts

type SSHOpts struct {
	SSHHost string `json:"sshhost"`
	SSHUser string `json:"sshuser"`
	SSHPort int    `json:"sshport,omitempty"`
}

func ParseOpts

func ParseOpts(input string) (*SSHOpts, error)

func (SSHOpts) String

func (opts SSHOpts) String() string

type SshKeywords

type SshKeywords struct {
	User                         string
	HostName                     string
	Port                         string
	IdentityFile                 []string
	BatchMode                    bool
	PubkeyAuthentication         bool
	PasswordAuthentication       bool
	KbdInteractiveAuthentication bool
	PreferredAuthentications     []string
	AddKeysToAgent               bool
	IdentityAgent                string
}

type UserInputCancelError

type UserInputCancelError struct {
	Err error
}

func (UserInputCancelError) Error

func (uice UserInputCancelError) Error() string