execution

package

Go to main page

Versions in this module

v0

v0.15.0

Sep 7, 2026

Changes in this version

+ const ErrorKindCancelled

+ const MaxJumpHops

+ const PlanSchemaVersion

+ func ClassifyLocalRisk(mode, action string) (Risk, Effects, bool)

+ func ClassifyRisk(action, command string, sudo bool) (Risk, Effects)

+ func CompletionForAttempt(phase, kind string, startAttempted, remoteStarted, exitObserved bool) string

+ func Digest(data []byte) string

+ func ValidatePlanHash(value string) error

+ func WithScopedTimeout(parent context.Context, timeout time.Duration, scope string) (context.Context, context.CancelFunc)

+ type BoundaryError struct

+ Kind string

+ Message string

+ func (e *BoundaryError) Error() string

+ func (e *BoundaryError) ErrorKind() string

+ type Condition struct

+ Expected string

+ Kind string

+ Observed string

+ Status string

+ Subject string

type DryRunPlan

+ Effects Effects

+ Plan *Plan

+ PlanHash string

+ Risk Risk

+ type Effects struct

+ Destructive bool

+ LocalWrite bool

+ Privileged bool

+ RemoteWrite bool

+ Unknown bool

+ func (e Effects) Risk() Risk

type Event

+ MaxFailures int

type HostRecord

+ Via string

type Limits

+ GlobalTimeout time.Duration

+ HostTimeout time.Duration

+ type Metadata struct

+ CancellationCause string

+ ChangeState string

+ DeadlineScope string

+ Effects Effects

+ Executed *bool

+ ExecutionFingerprint string

+ ExecutionID string

+ FinishedAt string

+ ParentExecutionID string

+ Peers []PeerIdentity

+ PlanHash string

+ Postconditions []Condition

+ Preconditions []Condition

+ Risk Risk

+ StartedAt string

+ TargetFingerprints []string

+ Verification string

+ Verified bool

+ func NewMetadata(plan *Plan, id string) Metadata

+ func (m *Metadata) Finish(status, phase, completion string, exitCode int, errorKind string)

+ func (m *Metadata) ObserveContext(ctx context.Context)

+ type PeerIdentity struct

+ Address string

+ AuthMethod string

+ HostKeyFingerprint string

+ Role string

+ SSHPasswordKey string

+ SudoPasswordKey string

+ User string

+ type Plan struct

+ Action string

+ Bindable bool

+ Effects Effects

+ Inputs map[string]string

+ PlanHash string

+ Risk Risk

+ SchemaVersion string

+ Semantics string

+ Targets []PlanTarget

+ Unresolved []string

+ func (p *Plan) Seal() error

+ func (p Plan) CanonicalBytes() ([]byte, error)

+ func (p Plan) CheckExpected(expected string) error

+ type PlanTarget struct

+ Address string

+ Alias string

+ Bind string

+ KeyFingerprint string

+ Port string

+ Role string

+ SSHPasswordKey string

+ SudoKey string

+ TrustSHA256 string

+ User string

type Policy

+ MaxFailures int

type PolicyPublic

+ MaxFailures int

type Request

+ ExecutionID string

+ Plan *Plan

type ResolvedTarget

+ ExpectedKeyFingerprint string

+ Jumps []ResolvedTarget

+ KnownHostsData []byte

+ Via string

+ func ResolveJumps(hosts []HostRecord, target ResolvedTarget, viaOverride *string) (ResolvedTarget, error)

type Result

+ PeerAddress string

+ type Risk string

+ const RiskDestructive

+ const RiskMutation

+ const RiskPrivileged

+ const RiskRead

type TargetResult

+ PeerAddress string

v0.13.0

Sep 1, 2026

v0.12.0

Aug 28, 2026

Changes in this version

+ func SupportedScriptRunner(name string) bool

type Payload

+ Shebang string

v0.11.0

Aug 25, 2026

Changes in this version

type HostRecord

+ Bind string

+ BindSet bool

type Policy

+ Bind string

+ BindSet bool

type PolicyPublic

+ Bind string

+ BindSet bool

type ResolvedTarget

+ Bind string

v0.10.0

Aug 24, 2026

Changes in this version

type DryRunPlan

+ SecretBackend string

+ SecretUnlock string

v0.9.0

Aug 24, 2026

v0.8.0

Aug 21, 2026

v0.7.0

Aug 16, 2026

v0.6.0

Aug 16, 2026

Changes in this version

+ const ActionApply

+ const ErrorKindPrecondition

v0.5.0

Aug 15, 2026

v0.4.1

Aug 15, 2026

v0.4.0

Aug 15, 2026

v0.3.0

Aug 13, 2026

Changes in this version

+ const ActionCommand

+ const ActionInspect

+ const ActionSFTP

+ const ActionScript

+ const ActionTransfer

+ const CompletionCompleted

+ const CompletionCompletedUnconfirmed

+ const CompletionNotStarted

+ const CompletionPartial

+ const CompletionUnknown

+ const DefaultConcurrency

+ const DefaultMaxOutput

+ const DefaultMaxPayload

+ const ErrorKindAuth

+ const ErrorKindBlocked

+ const ErrorKindConfig

+ const ErrorKindConnect

+ const ErrorKindExitMissing

+ const ErrorKindHostKey

+ const ErrorKindLocalIO

+ const ErrorKindProtocol

+ const ErrorKindRemoteExit

+ const ErrorKindRemoteIO

+ const ErrorKindTimeout

+ const ErrorKindUnknown

+ const EventRunFinished

+ const EventRunStarted

+ const EventSchemaVersion

+ const EventTargetFinished

+ const EventTargetStarted

+ const FailureContinue

+ const FailureFailFast

+ const IntentChange

+ const IntentRead

+ const IntentUnknown

+ const MaxConcurrency

+ const PhaseAdmission

+ const PhaseAuthenticate

+ const PhaseCollect

+ const PhaseComplete

+ const PhaseConnect

+ const PhaseExecute

+ const PhasePersist

+ const PhaseResolve

+ const RequestSchemaVersion

+ const ResultSchemaVersion

+ const RetrySafe

+ const RetryUnknown

+ const RetryUnsafe

+ const RetryVerifyFirst

+ const ScriptRunnerSH

+ const StatusFailed

+ const StatusSkipped

+ const StatusSucceeded

+ var ErrBlocked = errors.New("action blocked by safety policy")

+ var ErrConfig = errors.New("execution config error")

+ var ErrLocalIO = errors.New("local io error")

+ var ErrNoTargets = fmt.Errorf("%w: no targets matched", ErrConfig)

+ var ErrRemoteIO = errors.New("remote io error")

+ func Classify(err error) string

+ func CompletionFor(phase, kind string, remoteStarted bool, exitObserved bool) string

+ func IsRequestLevelError(err error) bool

+ func NewRunID() string

+ func NormalizeRequest(req *Request) error

+ func ProcessExitCode(counts RunCounts, requestErr error) int

+ func SafetyCheck(req *Request, payload []byte) error

+ type ActionSpec struct

+ Command string

+ Intent string

+ Kind string

+ LocalPath string

+ PayloadBytes int

+ PayloadSHA256 string

+ RemotePath string

+ ScriptFromStdin bool

+ ScriptPath string

+ ScriptRunner string

+ SftpAction string

+ UseSudo bool

+ type DefaultDialer struct

+ func (DefaultDialer) Connect(cfg *sshclient.Config) (*sshclient.SSHClient, error)

+ type Dialer interface

+ Connect func(cfg *sshclient.Config) (*sshclient.SSHClient, error)

+ type DryRunPlan struct

+ Action ActionSpec

+ DryRun bool

+ Error *ErrorInfo

+ Limits Limits

+ MayMutateKnownHosts bool

+ Notes []string

+ Policy PolicyPublic

+ RequestID string

+ SchemaVersion string

+ Snapshot TargetSnapshot

+ Valid bool

+ WouldConnect bool

+ WouldExecute bool

+ WouldMutateRemote bool

+ WouldReadSecret bool

+ WouldWriteLocal bool

+ func BuildDryRunPlan(req *Request, hosts []HostRecord, defaults HostRecord, payload *Payload) DryRunPlan

+ type ErrorInfo struct

+ Kind string

+ Message string

+ RetrySafety string

+ Retryable bool

+ func BuildError(err error, kind, intent, completion string) *ErrorInfo

+ type Event struct

+ Action *ActionSpec

+ Concurrency int

+ Counts *RunCounts

+ Error *ErrorInfo

+ FailureMode string

+ Kind string

+ RequestID string

+ Result *TargetResult

+ RunID string

+ SchemaVersion string

+ SelectorDigest string

+ Sequence int64

+ Target *ResolvedTarget

+ Timestamp string

+ type EventWriter interface

+ WriteEvent func(Event) error

+ type HostRecord struct

+ Address string

+ Groups []string

+ KeyPath string

+ Name string

+ Port string

+ SSHPasswordKey string

+ SudoPasswordKey string

+ Tags map[string]string

+ User string

+ type HumanWriter struct

+ W io.Writer

+ func (h *HumanWriter) WriteEvent(ev Event) error

+ type JSONLWriter struct

+ W io.Writer

+ func (j *JSONLWriter) WriteEvent(ev Event) error

+ type Limits struct

+ Concurrency int

+ MaxOutputBytesPerTarget int

+ MaxPayloadBytes int

+ Timeout time.Duration

+ type Payload struct

+ Bytes []byte

+ SHA256 string

+ Size int

+ func LoadScriptFile(path string, maxBytes int) (Payload, error)

+ func LoadScriptStdin(r io.Reader, maxBytes int) (Payload, error)

+ type Policy struct

+ AcceptUnknownHost bool

+ AllowInsecureHostKey bool

+ BypassReason string

+ FailureMode string

+ KeyPath string

+ KnownHostsPath string

+ SSHPassword string

+ SSHPasswordKey string

+ SafetyBypass bool

+ SafetyCheckEnabled bool

+ SudoPasswordKey string

+ UseKeyAuth bool

+ type PolicyPublic struct

+ AcceptUnknownHost bool

+ AllowInsecureHostKey bool

+ BypassReason string

+ FailureMode string

+ KeyPath string

+ KnownHostsPath string

+ SSHPasswordKey string

+ SSHPasswordProvided bool

+ SafetyBypass bool

+ SafetyCheckEnabled bool

+ SudoPasswordKey string

+ UseKeyAuth bool

+ func PublicPolicy(p Policy) PolicyPublic

+ type Request struct

+ Action ActionSpec

+ AuditEnabled bool

+ AuditOutput string

+ DryRun bool

+ JSONLOutput bool

+ JSONOutput bool

+ Limits Limits

+ Policy Policy

+ RequestID string

+ SchemaVersion string

+ Targets TargetSelector

+ type ResolvedTarget struct

+ Address string

+ Alias string

+ Groups []string

+ HostKeyFingerprint string

+ Index int

+ KeyPath string

+ Literal bool

+ Port string

+ SSHPasswordKey string

+ SudoPasswordKey string

+ Tags map[string]string

+ User string

+ type Result struct

+ Action ActionSpec

+ AuthMethod string

+ Command string

+ Completion string

+ DurationMs int64

+ Error *ErrorInfo

+ ErrorKind string

+ ExitCode int

+ Host string

+ Phase string

+ Port string

+ RequestID string

+ RunID string

+ SchemaVersion string

+ Status string

+ Stderr string

+ StderrTruncated bool

+ Stdout string

+ StdoutTruncated bool

+ Success bool

+ Target ResolvedTarget

+ User string

+ func ToResult(runID, requestID string, tr TargetResult) *Result

+ type RunCounts struct

+ Failed int

+ Selected int

+ Skipped int

+ Started int

+ Succeeded int

+ Uncertain int

+ type RunOptions struct

+ ActiveSessions *atomic.Int64

+ Dialer Dialer

+ Events EventWriter

+ MaxObserved *atomic.Int64

+ Payload *Payload

+ Request *Request

+ Secrets SecretResolver

+ Snapshot TargetSnapshot

+ type RunOutcome struct

+ Counts RunCounts

+ Results []TargetResult

+ RunID string

+ Single *Result

+ func Execute(ctx context.Context, opts RunOptions) (RunOutcome, error)

+ type SecretResolver interface

+ GetSSHPassword func(key string) (string, error)

+ GetSudoPassword func(key string) (string, error)

+ type SkippedTarget struct

+ Alias string

+ Reason string

+ type TargetResult struct

+ Action ActionSpec

+ AuthMethod string

+ Completion string

+ DurationMs int64

+ Error *ErrorInfo

+ ExitCode int

+ Phase string

+ Status string

+ Stderr string

+ StderrTruncated bool

+ Stdout string

+ StdoutTruncated bool

+ Target ResolvedTarget

+ type TargetSelector struct

+ Address string

+ AllHosts bool

+ Groups []string

+ Names []string

+ Port string

+ Tags map[string]string

+ User string

+ type TargetSnapshot struct

+ Count int

+ SelectorDigest string

+ Skipped []SkippedTarget

+ Targets []ResolvedTarget

+ func ResolveTargets(hosts []HostRecord, sel TargetSelector, defaults HostRecord) (TargetSnapshot, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL