shell

Documentation

Index

• Constants
• func SupportedShells() []string
• type SetupChecker
  • func NewSetupChecker() SetupChecker
• type Shell
  • func New(logTarget string) Shell

Constants

const RunbookCommandDelimiter = "COMMA"

Functions

func SupportedShells

func SupportedShells() []string

Types

type SetupChecker

type SetupChecker interface {
	// CheckSetup returns an non nil error if the shell setup is not correct
	// The error message should contain instructions on how to fix the setup and is safe to display to the user
	CheckSetup() error
}

func NewSetupChecker

func NewSetupChecker() SetupChecker

type Shell

type Shell interface {
	Spawn(ctx context.Context) (*exec.Cmd, error)
	TailHistory(ctx context.Context) ([]string, error)
	SpawnHistoryExpander(ctx context.Context) (*exec.Cmd, error)
	SpawnRunbookRunner(ctx context.Context, runbook *client.Runbook) (*exec.Cmd, error)
	DefaultStartingArrayIndex() int
}

func New

func New(logTarget string) Shell