shell

Apr 28, 2026

Changes in this version

type RunCommandOpt

+ func WithDone(done chan struct{}) RunCommandOpt

+ func WithStarted(started chan struct{}) RunCommandOpt

Nov 8, 2024

Changes in this version

+ var DiscardLogger = &WriterLogger

+ var ErrShellNotStarted = errors.New("shell not started")

+ var StderrLogger = &WriterLogger

+ func BatchEscape(str string) string

+ func ExitCode(err error) int

+ func IsExitError(err error) bool

+ func IsExitSignaled(err error) bool

+ func LookPath(file string, path string, fileExtensions string) (string, error)

+ type Command struct

+ func (c Command) Run(ctx context.Context, opts ...RunCommandOpt) error

+ func (c Command) RunAndCaptureStdout(ctx context.Context, opts ...RunCommandOpt) (string, error)

+ type ExitError struct

+ Code int

+ Err error

+ func (ee *ExitError) Error() string

+ func (ee *ExitError) Unwrap() error

+ type Logger interface

+ Commentf func(format string, v ...any)

+ Errorf func(format string, v ...any)

+ Headerf func(format string, v ...any)

+ OptionalWarningf func(id, format string, v ...any)

+ Printf func(format string, v ...any)

+ Promptf func(format string, v ...any)

+ Warningf func(format string, v ...any)

+ type LoggerStreamer struct

+ Logger Logger

+ Prefix string

+ func NewLoggerStreamer(logger Logger) *LoggerStreamer

+ func (l *LoggerStreamer) Close() error

+ func (l *LoggerStreamer) Output() error

+ func (l *LoggerStreamer) Write(p []byte) (n int, err error)

+ type NewShellOpt = func(*Shell)

+ func WithCommandLog(log *[][]string) NewShellOpt

+ func WithDebug(d bool) NewShellOpt

+ func WithDryRun(d bool) NewShellOpt

+ func WithEnv(e *env.Environment) NewShellOpt

+ func WithInterruptSignal(sig process.Signal) NewShellOpt

+ func WithLogger(l Logger) NewShellOpt

+ func WithPTY(pty bool) NewShellOpt

+ func WithSignalGracePeriod(d time.Duration) NewShellOpt

+ func WithStdout(w io.Writer) NewShellOpt

+ func WithTraceContextCodec(c tracetools.Codec) NewShellOpt

+ func WithWD(wd string) NewShellOpt

+ type RunCommandOpt = func(*runConfig)

+ func CaptureStdout(s *string) RunCommandOpt

+ func ShowPrompt(show bool) RunCommandOpt

+ func ShowStderr(show bool) RunCommandOpt

+ func WithExtraEnv(e *env.Environment) RunCommandOpt

+ func WithStringSearch(m map[string]bool) RunCommandOpt

+ type Shell struct

+ Env *env.Environment

+ func New(opts ...NewShellOpt) (*Shell, error)

+ func NewTestShell(t *testing.T, opts ...NewShellOpt) *Shell

+ func (s *Shell) AbsolutePath(executable string) (string, error)

+ func (s *Shell) Chdir(path string) error

+ func (s *Shell) CloneWithStdin(r io.Reader) *Shell

+ func (s *Shell) Command(command string, args ...string) Command

+ func (s *Shell) Getwd() string

+ func (s *Shell) Interrupt()

+ func (s *Shell) LockFile(ctx context.Context, path string) (Unlocker, error)

+ func (s *Shell) Script(path string) (Command, error)

+ func (s *Shell) Terminate()

+ func (s *Shell) WaitStatus() (process.WaitStatus, error)

+ type TestingLogger struct

+ func (tl TestingLogger) Commentf(format string, v ...any)

+ func (tl TestingLogger) Errorf(format string, v ...any)

+ func (tl TestingLogger) Headerf(format string, v ...any)

+ func (tl TestingLogger) OptionalWarningf(_id, format string, v ...any)

+ func (tl TestingLogger) Printf(format string, v ...any)

+ func (tl TestingLogger) Promptf(format string, v ...any)

+ func (tl TestingLogger) Warningf(format string, v ...any)

+ func (tl TestingLogger) Write(b []byte) (int, error)

+ type Unlocker interface

+ Unlock func() error

+ type WriterLogger struct

+ Ansi bool

+ DisabledWarningIDs []string

+ Writer io.Writer

+ func NewWriterLogger(writer io.Writer, ansi bool, disabledWarningIDs []string) *WriterLogger

+ func (wl *WriterLogger) Commentf(format string, v ...any)

+ func (wl *WriterLogger) Errorf(format string, v ...any)

+ func (wl *WriterLogger) Headerf(format string, v ...any)

+ func (wl *WriterLogger) OptionalWarningf(id, format string, v ...any)

+ func (wl *WriterLogger) Printf(format string, v ...any)

+ func (wl *WriterLogger) Promptf(format string, v ...any)

+ func (wl *WriterLogger) Warningf(format string, v ...any)

+ func (wl *WriterLogger) Write(b []byte) (int, error)