command

Documentation

Index

• type Command
  • func New(ctx context.Context, sess RemoteSession, name string, options ...Option) (*Command, error)
  • func (c *Command) CombinedOutput() ([]byte, error)
  • func (c *Command) Output() ([]byte, error)
  • func (c *Command) Run() error
  • func (c *Command) Start() error
  • func (c *Command) StderrPipe() (io.Reader, error)
  • func (c *Command) StdinPipe() (io.WriteCloser, error)
  • func (c *Command) StdoutPipe() (io.Reader, error)
  • func (c *Command) String() string
  • func (c *Command) Wait() error
• type Option
  • func Args(args ...string) Option
  • func Env(name, value string) Option
  • func Shell() Option
• type RemoteSession

Types

type Command

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

func New

func New(ctx context.Context, sess RemoteSession, name string, options ...Option) (*Command, error)

Create a command executor Note: this will close the session after execution

func (*Command) CombinedOutput

func (c *Command) CombinedOutput() ([]byte, error)

func (*Command) Output

func (c *Command) Output() ([]byte, error)

func (*Command) Run

func (c *Command) Run() error

func (*Command) Start

func (c *Command) Start() error

func (*Command) StderrPipe

func (c *Command) StderrPipe() (io.Reader, error)

func (*Command) StdinPipe

func (c *Command) StdinPipe() (io.WriteCloser, error)

func (*Command) StdoutPipe

func (c *Command) StdoutPipe() (io.Reader, error)

func (*Command) String

func (c *Command) String() string

func (*Command) Wait

func (c *Command) Wait() error

type Option

type Option func(c *Command) error

func Args

func Args(args ...string) Option

func Env

func Env(name, value string) Option

func Shell

func Shell() Option

starts a login shell

type RemoteSession

type RemoteSession interface {
	Close() error
	CombinedOutput(cmd string) ([]byte, error)
	Output(cmd string) ([]byte, error)
	Run(cmd string) error
	Setenv(name string, value string) error
	Shell() error
	Signal(sig ssh.Signal) error
	Start(cmd string) error
	StderrPipe() (io.Reader, error)
	StdinPipe() (io.WriteCloser, error)
	StdoutPipe() (io.Reader, error)
	Wait() error
}