package
2.0.0-alpha.3
Repository: https://github.com/k0sproject/rig.git
Documentation: pkg.go.dev

# Functions

AllowWinStderr exec option allows command to output to stderr without failing.
Build returns an instance of Options.
Decorate exec option for applying a custom decorator to the command string.
HideCommand exec option for hiding the command-string and stdin contents from the logs.
HideOutput exec option for hiding the command output from logs.
LogError exec option for enabling or disabling live error logging during exec.
Logger exec option for setting a custom logger.
LogInput exec option for enabling or disabling live input logging during exec.
NewErrorExecutor returns a new ErrorExecutor with the given error.
NewExecutor returns a new Executor.
PS exec option for using powershell to execute the command on windows.
PSCompressed is like PS but for long command scriptlets.
Redact exec option for defining a redact regexp pattern that will be replaced with [REDACTED] in the logs.
Sensitive exec option for disabling all logging of the command.
Stderr exec option for sending command stderr to an io.Writer.
Stdin exec option for sending data to the command through stdin.
StdinString exec option for sending string data to the command through stdin.
Stdout exec option for sending command stdout to an io.Writer.
StreamOutput exec option for sending the command output to info log.
TrimOutput exec option for controlling if the output of the command will be trimmed of whitespace.

# Constants

DefaultRedactMask is the string that will be used to replace redacted text in the logs.

# Variables

DisableRedact will disable all redaction of sensitive data.
ErrInvalidCommand is returned when a command is somehow invalid.
ErrWroteStderr is returned when a windows command writes to stderr, unless AllowWinStderr is set.

# Structs

ErrorExecutor is an executor that always returns the given error.
ExecOptions is a collection of exec options.
Executor is an Runner that runs commands on a host.

# Interfaces

ContextRunner is a command runner that can run commands with a context.
Formatter is an interface that can format commands.
Runner is a full featured command runner for clients.
SimpleRunner is a command runner that can run commands without a context.
WindowsChecker is implemented by types that can check if the underlying host OS is Windows.

# Type aliases

DecorateFunc is a function that takes a string and returns a decorated string.
ExecOption is a functional option for the exec package.