sshclient

package module

Go to main page

Versions in this module

v0

v0.0.3

Feb 16, 2024

Changes in this version

+ func RSCmd(cmd string) func(*RemoteScript)

+ func RSScript(script string) func(*RemoteScript)

+ func RSScriptFile(file string) func(*RemoteScript)

+ func RShell() func(*RemoteShell)

+ func RTerminal(config *TerminalConfig) func(*RemoteShell)

type RemoteScript

+ func NewRemoteScript(sshClient *ssh.Client, opts ...func(*RemoteScript)) *RemoteScript

type RemoteShell

+ func NewRemoteShell(sshClient *ssh.Client, opts ...func(*RemoteShell)) *RemoteShell

v0.0.2

Feb 16, 2024

Changes in this version

+ var ErrNotSupportedRemoteScript = errors.New("not supported RemoteScript type")

+ var ErrStderrAlreadySet = errors.New("stderr already set")

+ var ErrStdoutAlreadySet = errors.New("stdout already set")

type Client

+ func New(sshClient *ssh.Client) *Client

+ func (c *Client) Dial(network, addr string, config *ssh.ClientConfig) (*Client, error)

+ func (c *Client) DialWithKey(addr, user, keyfile string) (*Client, error)

+ func (c *Client) DialWithKeyWithPassphrase(addr, user, keyfile, passphrase string) (*Client, error)

+ func (c *Client) DialWithPasswd(addr, user, passwd string) (*Client, error)

+ func (c *Client) Sftp(opts ...SftpOption) *RemoteFileSystem

+ type RemoteFile struct

+ type RemoteFileSystem struct

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

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

+ func (rfs *RemoteFileSystem) Chtimes(path string, atime time.Time, mtime time.Time) error

+ func (rfs *RemoteFileSystem) Close() error

+ func (rfs *RemoteFileSystem) Create(path string) (*RemoteFile, error)

+ func (rfs *RemoteFileSystem) Download(remotePath, hostPath string) (retErr error)

+ func (rfs *RemoteFileSystem) Getwd() (string, error)

+ func (rfs *RemoteFileSystem) Glob(pattern string) (matches []string, err error)

+ func (rfs *RemoteFileSystem) Link(oldname, newname string) error

+ func (rfs *RemoteFileSystem) Lstat(path string) (os.FileInfo, error)

+ func (rfs *RemoteFileSystem) Mkdir(path string) error

+ func (rfs *RemoteFileSystem) MkdirAll(path string) error

+ func (rfs *RemoteFileSystem) Open(path string) (*RemoteFile, error)

+ func (rfs *RemoteFileSystem) OpenFile(path string, f int) (*RemoteFile, error)

+ func (rfs *RemoteFileSystem) PosixRename(oldname, newname string) error

+ func (rfs *RemoteFileSystem) ReadDir(path string) ([]os.FileInfo, error)

+ func (rfs *RemoteFileSystem) ReadFile(name string) ([]byte, error)

+ func (rfs *RemoteFileSystem) ReadLink(path string) (string, error)

+ func (rfs *RemoteFileSystem) RealPath(path string) (string, error)

+ func (rfs *RemoteFileSystem) Remove(path string) error

+ func (rfs *RemoteFileSystem) RemoveDirectory(path string) error

+ func (rfs *RemoteFileSystem) Rename(oldname, newname string) error

+ func (rfs *RemoteFileSystem) Stat(path string) (os.FileInfo, error)

+ func (rfs *RemoteFileSystem) StatVFS(path string) (*StatVFS, error)

+ func (rfs *RemoteFileSystem) Symlink(oldname, newname string) error

+ func (rfs *RemoteFileSystem) Truncate(path string, size int64) error

+ func (rfs *RemoteFileSystem) Upload(hostPath, remotePath string) (retErr error)

+ func (rfs *RemoteFileSystem) Wait() error

+ func (rfs *RemoteFileSystem) Walk(root string) (*fs.Walker, error)

+ func (rfs *RemoteFileSystem) WriteFile(name string, data []byte, perm os.FileMode) error

+ type SftpOption func(*remoteFileSystemConfig)

+ func SftpMaxConcurrentRequestsPerFile(n int) SftpOption

+ func SftpMaxPacket(size int) SftpOption

+ func SftpUseConcurrentReads(value bool) SftpOption

+ func SftpUseConcurrentWrites(value bool) SftpOption

+ func SftpUseFstat(value bool) SftpOption

+ type StatVFS struct

v0.0.1

Jun 4, 2021

Changes in this version

+ type Client struct

+ func Dial(network, addr string, config *ssh.ClientConfig) (*Client, error)

+ func DialWithKey(addr, user, keyfile string) (*Client, error)

+ func DialWithKeyWithPassphrase(addr, user, keyfile string, passphrase string) (*Client, error)

+ func DialWithPasswd(addr, user, passwd string) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Cmd(cmd string) *RemoteScript

+ func (c *Client) Script(script string) *RemoteScript

+ func (c *Client) ScriptFile(fname string) *RemoteScript

+ func (c *Client) Shell() *RemoteShell

+ func (c *Client) Terminal(config *TerminalConfig) *RemoteShell

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

+ type RemoteScript struct

+ func (rs *RemoteScript) Cmd(cmd string) *RemoteScript

+ func (rs *RemoteScript) Output() ([]byte, error)

+ func (rs *RemoteScript) Run() error

+ func (rs *RemoteScript) SetStdio(stdout, stderr io.Writer) *RemoteScript

+ func (rs *RemoteScript) SmartOutput() ([]byte, error)

+ type RemoteShell struct

+ func (rs *RemoteShell) SetStdio(stdin io.Reader, stdout, stderr io.Writer) *RemoteShell

+ func (rs *RemoteShell) Start() error

+ type TerminalConfig struct

+ Height int

+ Modes ssh.TerminalModes

+ Term string

+ Weight int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL