ssh

package

v0.0.10 Latest Latest Go to latest Published: Dec 4, 2023 License: MPL-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Dial(
	forward types.DialCloser,
	dialHost types.HostOption,
) (*ssh.Client, error)

func New(opts types.HostOptions) (types.Host, error)

type Host struct {
	// contains filtered or unexported fields
}

func (h *Host) Close() error

func (h *Host) DownloadDirectory(
	ctx context.Context,
	from string,
) (types.DirectoryReadCloser, error)

func (h *Host) DownloadFile(
	ctx context.Context,
	from string,
) (types.FileReadCloser, error)

func (h *Host) Execute(
	ctx context.Context,
	cmd string,
	args ...string,
) error

func (h *Host) ExecuteWithOutput(
	ctx context.Context,
	cmd string,
	args ...string,
) ([]byte, error)

func (h *Host) Shell(
	ctx context.Context,
	cmdArgs ...string,
) (types.Terminal, error)

func (h *Host) State(ctx context.Context) (types.HostStatus, error)

func (h *Host) UploadDirectory(
	ctx context.Context,
	from types.DirectoryReader,
	to string,
) error

func (h *Host) UploadFile(
	ctx context.Context,
	from types.FileReader,
	to string,
) (err error)

type Terminal struct {
	io.WriteCloser
	io.Reader
	// contains filtered or unexported fields
}

func (t *Terminal) Close() error

func (t *Terminal) Execute(cmd string, args ...string) error

func (t *Terminal) ExecuteWithOutput(
	cmd string,
	args ...string,
) ([]byte, error)