Documentation
¶
Overview ¶
Package powershell provides PowerShell 7+ command execution actions for the operation graph.
Commands are run via `pwsh -NoLogo -NoProfile -Command <command>`. PowerShell 7+ is cross-platform — `pwsh` runs on Windows, macOS, and Linux — so this provider is platform-agnostic and requires only that `pwsh` is on PATH. The legacy Windows-only `powershell.exe` (PowerShell 5.x) is not supported.
Returns a Result with the original command, both captured streams, and the subprocess exit code so the value can be Emitted to a [result.Sink] (JSON, YAML, or CSV) and returned to the caller in one shape.
Index ¶
Constants ¶
const (
Exec op.ActionName = "powershell.exec"
)
Action-name constants for the powershell provider's plan-mode actions.
Each constant is the short dotted action label its method dispatches under. Pass these to plan.Plan, op.ReceiverRegistry().BuildAction, RuntimeEnvironment.ActionByName, or WithActionNamed in place of a string literal so a typo is a compile error and rename / find-references work through the constant.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
op.ProviderBase
}
Provider provides PowerShell 7+ command execution.
func NewProvider ¶
func NewProvider(runtimeEnvironment *op.RuntimeEnvironment) *Provider
NewProvider constructs a PowerShell Provider bound to the given runtime environment.
Parameters:
- `runtimeEnvironment`: the runtime environment that supplies the subprocess context, status sink, and result sink.
Returns:
- `*Provider`: the initialized provider.
func (*Provider) Exec ¶
Exec executes a PowerShell command via `pwsh` (PowerShell 7+) and returns the structured execution result.
The command is invoked as:
pwsh -NoLogo -NoProfile -Command <command>
- `-NoLogo` suppresses the startup banner.
- `-NoProfile` prevents sourcing `$PROFILE`, so user-specific profile output never contaminates the captured
streams.
Parameters:
- `command`: PowerShell command string passed to `pwsh -Command`.
Returns:
- `*Result`: command, both captured streams, and the exit code; nil only when command is empty.
- `error`: any error from cmd.Run (the result is still returned with whatever was captured).
type Result ¶
type Result struct {
// Command is the command string passed to pwsh -Command.
Command string `json:"command" yaml:"command" csv:"command"`
// ExitCode is the subprocess exit code; 0 on success.
ExitCode int `json:"exit" yaml:"exit" csv:"exit"`
// Stderr holds streams 2-6 (Error, Warning, Verbose, Debug, Information) by default.
Stderr string `json:"stderr" yaml:"stderr" csv:"stderr"`
// Stdout holds stream 1 (Output) by default.
Stdout string `json:"stdout" yaml:"stdout" csv:"stdout"`
}
Result is the structured outcome of a PowerShell command execution.
PowerShell has six streams (Output 1, Error 2, Warning 3, Verbose 4, Debug 5, Information 6). At the OS process level these collapse to two: stream 1 → Stdout; streams 2-6 → Stderr (by default). Callers who need finer control redirect inside the command itself using PowerShell operators (`*>&1`, `4>&1`, etc.).
pwsh defaults to UTF-8 across all platforms, so Stdout and Stderr are valid UTF-8 strings without transcoding.
Source Files
Directories