evo

package module

Go to main page

Versions in this module

v1

v1.0.0

Sep 17, 2026

Changes in this version

+ const FormatJSON

+ const FormatJSONL

+ const ProblemCodeDuplicateSiblingName

+ const ProblemCodeVerificationUnsatisfied

+ const ResolutionAlreadySatisfied

+ const ResolutionExecuted

+ const ResolutionNoWork

+ var ErrDuplicateSiblingName = engine.ErrDuplicateSiblingName

+ var ErrExecExecutableNotFound = engine.ErrExecExecutableNotFound

+ var ErrExecNonzeroExit = engine.ErrExecNonzeroExit

+ var ErrExecOutputMissingAfterSuccess = engine.ErrExecOutputMissingAfterSuccess

+ var ErrExecSpecMissingExecutable = engine.ErrExecSpecMissingExecutable

+ var ErrFilePathIsSymlink = engine.ErrFilePathIsSymlink

+ var ErrFilePathTypeMismatch = engine.ErrFilePathTypeMismatch

+ var ErrFileSpecMissingPath = engine.ErrFileSpecMissingPath

+ var ErrFileUnmanagedContentsMissing = engine.ErrFileUnmanagedContentsMissing

+ var ErrKeyAfterDefine = engine.ErrKeyAfterDefine

+ var ErrNoTaskContext = engine.ErrNoTaskContext

+ var ErrTaskClosed = engine.ErrTaskClosed

+ func Exec(ctx context.Context, spec ExecSpec) error

+ func File(ctx context.Context, spec FileSpec) error

+ type EvidencePhase = core.EvidencePhase

+ type ExecSpec = engine.ExecSpec

+ type FileFS = engine.FileFS

+ type FileSpec = engine.FileSpec

+ type Fingerprint = fingerprint.Fingerprint

+ func App() Fingerprint

+ func FSPath(path string) Fingerprint

+ func Value(name string, v any) Fingerprint

+ type FingerprintValue = fingerprint.FingerprintValue

type Format

+ func ParseFormat(s string) (Format, error)

type Option

+ func Runner(r ProcessRunner) Option

+ type ProcessCommand = engine.ProcessCommand

+ type ProcessOutcome = engine.ProcessOutcome

+ type ProcessRunner = engine.ProcessRunner

+ type Resolution = core.Resolution

+ type Result = core.Result

+ type RunFunc = engine.RunFunc

+ type TaskEvidence = core.TaskEvidence

type TaskHandle

+ func (t *TaskHandle) Key(key string) *TaskHandle

+ func (t *TaskHandle) Verify(fn func(context.Context) (bool, error)) *TaskHandle

v0

v0.5.2

Sep 15, 2026

v0.5.1

Sep 14, 2026

v0.5.0

Sep 11, 2026

Changes in this version

+ const ProjectionJSON

+ const ProjectionJSONL

+ const ProjectionPlain

+ const ProjectionStreamJSON

+ var ErrNotStarted = engine.ErrNotStarted

+ var ErrWaitDeadlock = engine.ErrWaitDeadlock

+ func EncodeEventJSON(e Event) ([]byte, error)

type GroupHandle

+ func (g *GroupHandle) Each(items []string) iter.Seq2[string, *TaskHandle]

+ func (g *GroupHandle) Group(name string) *GroupHandle

+ func (g *GroupHandle) Sequence(name string) *SequenceHandle

+ type MutationOption = engine.MutationOption

type Output

+ func (o *Output) Context() context.Context

+ type Projection = engine.Projection

type SequenceHandle

+ func (s *SequenceHandle) Each(items []string) iter.Seq2[string, *TaskHandle]

+ func (s *SequenceHandle) Group(name string) *GroupHandle

type TaskHandle

+ func (t *TaskHandle) After(preds ...any) *TaskHandle

+ func (t *TaskHandle) Context() context.Context

+ func (t *TaskHandle) Define(fn func() error)

+ func (t *TaskHandle) Wait() error

v0.4.6

Sep 5, 2026

v0.4.5

Sep 5, 2026

v0.4.4

Sep 4, 2026

v0.4.3

Sep 4, 2026

v0.4.2

Sep 4, 2026

v0.4.1

Sep 4, 2026

v0.4.0

Sep 4, 2026

Changes in this version

+ func Fact(name, value string)

+ func MainWith(out *Output, run func(*Output) error)

+ func Run(run func() error) int

+ func Warn(summary string, args ...any)

+ type DisplayGroup struct

+ func (g *DisplayGroup) DisplayGroup(name string, args ...any) *DisplayGroup

+ func (g *DisplayGroup) Sequence(name string, args ...any) *SequenceHandle

+ func (g *DisplayGroup) Snapshot() TasksSnapshot

+ func (g *DisplayGroup) Summary(text string, args ...any) *DisplayGroup

+ func (g *DisplayGroup) Task(name string, args ...any) *TaskHandle

+ type EffectOption interface

+ func Affected(n int) EffectOption

+ type FactRecord = core.Fact

type Output

+ func (o *Output) DisplayGroup(name string, args ...any) *DisplayGroup

+ func (o *Output) Fact(name, value string)

+ func (o *Output) Sequence(name string, args ...any) *SequenceHandle

+ func (o *Output) Warn(summary string, args ...any)

+ type SequenceHandle struct

+ func Sequence(name string, args ...any) *SequenceHandle

+ func (g *SequenceHandle) DisplayGroup(name string, args ...any) *DisplayGroup

+ func (g *SequenceHandle) Sequence(name string, args ...any) *SequenceHandle

+ func (g *SequenceHandle) Snapshot() TasksSnapshot

+ func (g *SequenceHandle) Summary(text string, args ...any) *SequenceHandle

+ func (g *SequenceHandle) Task(name string, args ...any) *TaskHandle

type TaskHandle

+ func (t *TaskHandle) Doing(text string, args ...any) *TaskHandle

+ func (t *TaskHandle) Fact(name, value string)

+ func (t *TaskHandle) Writer() io.Writer

v0.3.3

Sep 4, 2026

v0.3.2

Sep 4, 2026

v0.3.1

Sep 4, 2026

v0.3.0

Sep 4, 2026

Changes in this version

+ var ErrConcurrentRunning = errors.New("evo: two siblings in the same collection are Running simultaneously")

+ var ErrDryRunDeclaredLate = errors.New("evo: DeclareDryRun called after a durable row was already emitted")

+ var ErrReasonSkipOnly = errors.New("evo: reason restricted to Skipped was recorded via Kept")

+ var ErrReasonWrongTask = errors.New("evo: reason restricted to another task")

+ var ErrTerminalWithoutSink = errors.New("evo: Terminal driver configured without a primary writer")

+ func AnyBlockedSoFar() bool

+ func AnyFailed() bool

+ func Confirm(question string, opts ...ConfirmOption) bool

+ func Pluralize(quantity int64, singular string) string

+ func Print(args ...any)

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

+ func Println(args ...any)

+ func SetDefault(out *Output)

+ func SlogHandler() slog.Handler

type Action

+ func Label(text string) Action

+ type Attachment struct

+ Label string

+ Value string

type Changes

+ func (c *Changes) Deleted(quantity int, object string) *Changes

+ func (c *Changes) Pushed(quantity int, object string) *Changes

type ChangesSnapshot

+ IntendedVerb string

type Conclusion

+ Warned bool

type Config

+ DryRun bool

+ Glyphs GlyphProfile

+ Isolated bool

+ Options []Option

+ Stdin io.Reader

+ type ConfirmOption func(*confirmConfig)

+ func AssumeYes(v bool) ConfirmOption

+ func ConfirmDetail(lines ...string) ConfirmOption

+ func Destructive() ConfirmOption

+ func PolicyFlag(flag string) ConfirmOption

+ func PolicyHint(command string, args ...string) ConfirmOption

type DebugConfig

+ AddSource bool

type EntityOption

+ func StartPhase(text string) EntityOption

type EntityState

+ const NotStarted

type Evidence

+ func (c *Evidence) Close() error

+ func (c *Evidence) DetailTail() ProblemOption

+ func (c *Evidence) Empty() bool

+ func (c *Evidence) Stderr() io.Writer

+ func (c *Evidence) Stdout() io.Writer

+ func (c *Evidence) Text() string

+ func (c *Evidence) Write(p []byte) (int, error)

+ type EvidenceOption interface

+ func MaxEvidenceBytes(n int) EvidenceOption

+ type EvidenceStream uint8

+ const EvidenceStreamCombined

+ const EvidenceStreamStderr

+ const EvidenceStreamStdout

+ type Failure struct

+ func (f *Failure) Error() string

+ func (f *Failure) Next(actions ...Action) *Failure

+ func (f *Failure) NextCommand(executable string, args ...string) *Failure

+ func (f *Failure) Unwrap() error

+ type GlyphProfile int

+ const GlyphsASCII

+ const GlyphsAuto

+ const GlyphsUnicode

+ type GroupHandle struct

+ func Group(name string, args ...any) *GroupHandle

+ func (g *GroupHandle) Snapshot() TasksSnapshot

+ func (g *GroupHandle) Summary(text string, args ...any) *GroupHandle

+ func (g *GroupHandle) Task(name string, args ...any) *TaskHandle

type Option

+ func DebugAddSource() Option

+ func DryRun() Option

+ func Glyphs(p GlyphProfile) Option

+ func Stdin(r io.Reader) Option

type Output

+ func Default() *Output

+ func Init(configs ...Config) *Output

+ func (o *Output) AnyBlockedSoFar() bool

+ func (o *Output) Confirm(question string, opts ...ConfirmOption) bool

+ func (o *Output) DeclareDryRun()

+ func (o *Output) Evidence(opts ...EvidenceOption) *Evidence

+ func (o *Output) Failf(format string, args ...any)

+ func (o *Output) Group(name string, args ...any) *GroupHandle

+ func (o *Output) Run(run func(*Output) error) int

+ func (o *Output) Subject(text string)

type PlainOptions

+ Glyphs GlyphProfile

+ Verbose bool

type Plan

+ func (p *Plan) Push(quantity int, object string) *Plan

type PlanSnapshot

+ IntendedVerb string

type Problem

+ EvidenceTail string

+ type ReasonOption interface

+ func ForSkip() ReasonOption

+ func OnTask(taskName string) ReasonOption

type Snapshot

+ DryRun bool

+ type SourceLocation struct

+ Column int

+ Line int

+ Path string

+ type TaskHandle struct

+ func (t *TaskHandle) Add(quantity int, object string)

+ func (t *TaskHandle) Block(summary string, options ...ProblemOption)

+ func (t *TaskHandle) Blockf(format string, args ...any) *Failure

+ func (t *TaskHandle) Bytes(completed, total int64) *TaskHandle

+ func (t *TaskHandle) Cancel(reason string) *TaskHandle

+ func (t *TaskHandle) Create(object string)

+ func (t *TaskHandle) Delete(quantity int, object string)

+ func (t *TaskHandle) Done(args ...any) *TaskHandle

+ func (t *TaskHandle) Each(items []string) iter.Seq[string]

+ func (t *TaskHandle) EachN(n int) iter.Seq[int]

+ func (t *TaskHandle) Evidence(opts ...EvidenceOption) *Evidence

+ func (t *TaskHandle) Fail(summary string, options ...ProblemOption)

+ func (t *TaskHandle) Failf(format string, args ...any) *Failure

+ func (t *TaskHandle) Kept(reason TaxonomyReason, name string, errs ...error)

+ func (t *TaskHandle) Next(actions ...Action) *TaskHandle

+ func (t *TaskHandle) NextCommand(executable string, args ...string) *TaskHandle

+ func (t *TaskHandle) NextSelf(args ...string) *TaskHandle

+ func (t *TaskHandle) Phase(text string, args ...any) *TaskHandle

+ func (t *TaskHandle) PhaseWriter() io.Writer

+ func (t *TaskHandle) Progress(completed, total int) *TaskHandle

+ func (t *TaskHandle) Push(quantity int, object string)

+ func (t *TaskHandle) Record(verb string, quantity int, object string)

+ func (t *TaskHandle) RecordLabel(label string, quantity int, object string)

+ func (t *TaskHandle) RecordName(verb, object string)

+ func (t *TaskHandle) Remove(quantity int, object string)

+ func (t *TaskHandle) Run(cmd *exec.Cmd) error

+ func (t *TaskHandle) Skip(reason string, args ...any) *TaskHandle

+ func (t *TaskHandle) Skipped(reason TaxonomyReason, name string, errs ...error)

+ func (t *TaskHandle) Snapshot() TaskSnapshot

+ func (t *TaskHandle) Step(completed, total int, name string) *TaskHandle

+ func (t *TaskHandle) Unchanged(args ...any) *TaskHandle

+ func (t *TaskHandle) Update(quantity int, object string)

+ func (t *TaskHandle) Warn(summary string, args ...any)

+ func (t *TaskHandle) Write(object string)

type TaskSnapshot

+ ActivityAt time.Time

+ Kept []TaxonomyRecord

+ Skipped []TaxonomyRecord

+ type TaxonomyReason struct

+ func Reason(name string, args ...any) TaxonomyReason

+ func (r TaxonomyReason) Name() string

+ type TaxonomyRecord struct

+ Causes []string

+ Name string

+ Reason string

type Visibility

+ const VisibilityNormal

+ const VisibilityVerbose

v0.2.16

Sep 1, 2026

Changes in this version

+ const DefaultVisibleNames

+ func TruncateNames(names []string, visible int) string

type Changes

+ func (c *Changes) RecordName(verb, object string) *Changes

type Plan

+ func (p *Plan) RecordName(verb, object string) *Plan

v0.2.15

Aug 27, 2026

v0.2.14

Aug 27, 2026

v0.2.13

Jul 29, 2026

v0.2.12

Jul 29, 2026

Changes in this version

type Config

+ FailedExitCode int

v0.2.11

Jul 28, 2026

v0.2.10

Jul 28, 2026

Changes in this version

+ const PublishedRelease

v0.2.9

Jul 28, 2026

v0.2.8

Jul 28, 2026

v0.2.7

Jul 28, 2026

Changes in this version

+ func Delay(d time.Duration) *time.Duration

type Item

+ func (i *Item) Capture(opts ...CaptureOption) *Capture

type Option

+ func Title(subject string) Option

type Scope

+ func (s *Scope) Tasks(name string) *Tasks

v0.2.6

Jul 28, 2026

Changes in this version

type Scope

+ func (s *Scope) Capture(opts ...CaptureOption) *Capture

v0.2.5

Jul 28, 2026

v0.2.4

Jul 27, 2026

Changes in this version

type LogLevel

+ const LevelUnset

+ type LogRecord struct

+ Attrs []slog.Attr

+ Level slog.Level

+ Message string

+ PC uintptr

+ Time time.Time

v0.2.3

Jul 27, 2026

Changes in this version

type Config

+ Result io.Writer

+ type EntityOption interface

+ func ID(id string) EntityOption

type ItemSnapshot

+ Key string

type JSONItem

+ Key string

type JSONTask

+ Key string

type Option

+ func ResultStream(w io.Writer) Option

type Output

+ func (o *Output) ResultWriter() io.Writer

+ func (o *Output) Scope(name string) *Scope

+ type Scope struct

+ func (s *Scope) Item(name string, opts ...EntityOption) *Item

+ func (s *Scope) Name() string

+ func (s *Scope) SlogHandler(min slog.Leveler) slog.Handler

+ func (s *Scope) Task(name string, opts ...EntityOption) *Task

+ func (s *Scope) Writer() io.Writer

type TaskSnapshot

+ Key string

v0.2.2

Jul 27, 2026

Changes in this version

type CaptureOption

+ func MirrorToDebug() CaptureOption

+ func MirrorToDiagnostics() CaptureOption

+ type CaptureStream uint8

+ const CaptureStreamCombined

+ const CaptureStreamStderr

+ const CaptureStreamStdout

v0.2.1

Jul 27, 2026

v0.2.0

Jul 27, 2026

Changes in this version

+ func WriteJSON(w io.Writer, snapshot Snapshot) error

+ func WriteJSONL(w io.Writer, events []Event) error

+ type ColorMode int

+ const ColorAlways

+ const ColorAuto

+ const ColorNever

+ func ParseColorMode(s string) (ColorMode, error)

type Config

+ Color ColorMode

+ Debug DebugConfig

+ ForcePlain bool

+ Format Format

+ MaxEntities int

+ MaxEvents int

+ MaxFrameRate int

+ NonInteractive bool

+ Stderr io.Writer

+ Stdout io.Writer

+ Terminal TerminalDriver

+ Title string

+ Verbosity Verbosity

+ VisibilityDelay time.Duration

+ func DefaultConfig() Config

+ type DebugConfig struct

+ Level LogLevel

+ NewestFirst *bool

+ PaneHeight int

+ PreserveAlways bool

+ View DebugPresentation

+ type Format int

+ const FormatData

+ const FormatExternal

+ const FormatHuman

type JSONDocument

+ Messages []JSONMessage

+ type JSONMessage struct

+ ID string

+ Text string

+ Visibility string

+ type MessageSnapshot struct

+ ID string

+ Text string

+ Visibility Visibility

type Output

+ func NewWithOptions(options ...Option) *Output

+ func (o *Output) At(visibility Visibility) *Printer

+ func (o *Output) Changesf(format string, args ...any) *Changes

+ func (o *Output) Itemf(format string, args ...any) *Item

+ func (o *Output) Planf(format string, args ...any) *Plan

+ func (o *Output) Print(args ...any) (int, error)

+ func (o *Output) Printf(format string, args ...any) (int, error)

+ func (o *Output) Println(args ...any) (int, error)

+ func (o *Output) Taskf(format string, args ...any) *Task

+ func (o *Output) Tasksf(format string, args ...any) *Tasks

+ func (o *Output) Verbose() *Printer

+ func (o *Output) Writer() io.Writer

+ type Printer struct

+ func (p *Printer) Print(args ...any) (int, error)

+ func (p *Printer) Printf(format string, args ...any) (int, error)

+ func (p *Printer) Println(args ...any) (int, error)

+ func (p *Printer) Writer() io.Writer

type Snapshot

+ Messages []MessageSnapshot

type Task

+ func (t *Task) Progress64(completed, total int64) *Task

type Tasks

+ func (g *Tasks) Taskf(format string, args ...any) *Task

+ type UsageError struct

+ Msg string

+ Op string

+ func (e *UsageError) Error() string

+ type Verbosity int

+ const VerbosityNormal

+ const VerbosityVerbose

+ type Visibility uint8

+ const Normal

+ const Verbose

v0.1.2

Jul 27, 2026

Changes in this version

type Capture

+ func (c *Capture) DetailTail() ProblemOption

+ func (c *Capture) Lines() []string

+ func (c *Capture) Stderr() io.Writer

+ func (c *Capture) Stdout() io.Writer

+ func (c *Capture) TaskName() string

+ func (c *Capture) Text() string

type CaptureOption

+ func KeepLastLines(n int) CaptureOption

+ func MaxCaptureBytes(n int) CaptureOption

type Task

+ func (t *Task) Capture(opts ...CaptureOption) *Capture

v0.1.1

Jul 27, 2026

Changes in this version

+ type Capture struct

+ func (c *Capture) Close() error

+ func (c *Capture) Empty() bool

+ func (c *Capture) Tail() string

+ func (c *Capture) Write(p []byte) (int, error)

+ type CaptureOption interface

+ func CaptureBytes(n int) CaptureOption

+ func CaptureLines(n int) CaptureOption

+ func CaptureQuiet() CaptureOption

type Output

+ func (o *Output) Capture(opts ...CaptureOption) *Capture

type ProblemOption

+ func DetailTail(c *Capture) ProblemOption

v0.1.0

Jul 27, 2026

Changes in this version

+ const Debug

+ const EventSchemaVersion

+ const ExitBlocked

+ const ExitCancelled

+ const ExitFailed

+ const ExitOK

+ const JSONSchemaVersion

+ var ErrAlreadyResolved = errors.New("evo: entity is already resolved")

+ var ErrClosed = errors.New("evo: output is closed")

+ var ErrDuplicateKey = errors.New("evo: duplicate entity key")

+ var ErrFinishing = errors.New("evo: output is finishing")

+ var ErrInvalidConfig = errors.New("evo: invalid configuration")

+ var ErrInvalidProgress = errors.New("evo: invalid progress")

+ var ErrLimitExceeded = errors.New("evo: resource limit exceeded")

+ var ErrNoProblems = errors.New("evo: structured resolution requires problems")

+ var ErrProgressRegression = errors.New("evo: progress moved backward")

+ var ErrRenderer = errors.New("evo: renderer failure")

+ var ErrUnresolvedItem = errors.New("evo: item has no final state")

+ var ErrUnresolvedTask = errors.New("evo: task has no final state")

+ func EncodeJSON(s Snapshot, _ ...JSONOptions) ([]byte, error)

+ func EncodeJSONL(events []Event, _ ...JSONLOptions) ([]byte, error)

+ func IsCharDevice(w io.Writer) bool

+ func Main(out *Output, run func(*Output) error) int

+ func RenderPlain(s Snapshot, opts PlainOptions) ([]byte, error)

+ type Action struct

+ Command *CommandSpec

+ Destructive bool

+ Explanation string

+ File string

+ Label string

+ RequiresConfirmation bool

+ URL string

+ func Command(executable string, args ...string) Action

+ type CapabilityProfile struct

+ Color ColorLevel

+ Height int

+ Interactive bool

+ NoColor bool

+ Unicode bool

+ Width int

+ func DetectCapabilities(opts ...Option) CapabilityProfile

+ type Changes struct

+ func (c *Changes) Added(quantity int64, object string) *Changes

+ func (c *Changes) Created(object string) *Changes

+ func (c *Changes) Moved(source, destination string) *Changes

+ func (c *Changes) Record(verb string, quantity int64, object string) *Changes

+ func (c *Changes) Removed(quantity int64, object string) *Changes

+ func (c *Changes) Reused(quantity int64, object string) *Changes

+ func (c *Changes) Updated(quantity int64, object string) *Changes

+ func (c *Changes) Wrote(object string) *Changes

+ type ChangesSnapshot struct

+ ID string

+ Records []EffectRecord

+ Subject string

+ type ColorLevel int

+ const Color256

+ const ColorBasic

+ const ColorNone

+ const ColorTrue

+ type CommandSpec struct

+ Args []string

+ Executable string

+ WorkingDir string

+ type Conclusion struct

+ Actions []Action

+ Cancelled bool

+ Changed bool

+ Changes []ChangesSnapshot

+ Collections []TasksSnapshot

+ ExitCode int

+ Explanation string

+ Items []ItemSnapshot

+ Partial bool

+ Plans []PlanSnapshot

+ State ConclusionState

+ Subject string

+ Tasks []TaskSnapshot

+ func (c Conclusion) AnyBlocked() bool

+ type ConclusionJSON struct

+ Cancelled bool

+ Changed bool

+ ExitCode int

+ Explanation string

+ Partial bool

+ State ConclusionState

+ type ConclusionState string

+ const StateBlocked

+ const StateCancelled

+ const StateChanged

+ const StateFailed

+ const StatePartial

+ const StatePlanned

+ const StateReady

+ const StateUnchanged

+ const StateWarning

+ type Config struct

+ Capabilities *CapabilityProfile

+ Clock TimeSource

+ Diagnostic io.Writer

+ NoColor bool

+ Plain bool

+ Primary io.Writer

+ Projection ProjectionPolicy

+ Redactor Redactor

+ Strict bool

+ Subject string

+ Width int

+ type DebugPaneOption interface

+ func NewestFirst() DebugPaneOption

+ func OldestFirst() DebugPaneOption

+ func PaneHeight(lines int) DebugPaneOption

+ func PreserveDebugTail() DebugPaneOption

+ type DebugPresentation int

+ const DebugPresentationHistory

+ const DebugPresentationPane

+ type EffectRecord struct

+ HasQty bool

+ Object string

+ Quantity int64

+ Verb string

+ type EntityState string

+ const Blocked

+ const Cancelled

+ const Done

+ const Empty

+ const Failed

+ const Incomplete

+ const OK

+ const Pending

+ const Running

+ const Skipped

+ const Unknown

+ const Warning

+ type Event struct

+ Activation string

+ Completed *int64

+ EntityID string

+ Name string

+ OutputID string

+ Payload map[string]any

+ SchemaVersion string

+ Sequence uint64

+ State string

+ Timestamp time.Time

+ Total *int64

+ Type string

+ type EventJSON struct

+ Activation string

+ Completed *int64

+ EntityID string

+ Name string

+ OutputID string

+ SchemaVersion string

+ Sequence uint64

+ State string

+ Timestamp time.Time

+ Total *int64

+ Type string

+ type Evidence struct

+ Label string

+ Value string

+ type Field struct

+ Key string

+ Sensitive bool

+ Value any

+ func Duration(key string, value interface{ ... }) Field

+ func Int(key string, value int) Field

+ func String(key, value string) Field

+ type FixedClock struct

+ T time.Time

+ func (c FixedClock) Now() time.Time

+ type Item struct

+ func (i *Item) Because(text string) *Item

+ func (i *Item) Block(summary string, options ...ProblemOption) *Item

+ func (i *Item) BlockedBy(problems ...Problem) *Item

+ func (i *Item) Fail(summary string, options ...ProblemOption) *Item

+ func (i *Item) FailedBy(problems ...Problem) *Item

+ func (i *Item) Next(actions ...Action) *Item

+ func (i *Item) NextCommand(executable string, args ...string) *Item

+ func (i *Item) OK() *Item

+ func (i *Item) Skip(reason string) *Item

+ func (i *Item) Snapshot() ItemSnapshot

+ func (i *Item) Start() *Item

+ func (i *Item) Unknown(summary string, options ...ProblemOption) *Item

+ func (i *Item) Warn(summary string, options ...ProblemOption) *Item

+ func (i *Item) WarnedBy(problems ...Problem) *Item

+ type ItemSnapshot struct

+ Actions []Action

+ Because string

+ Declaration int

+ ID string

+ Name string

+ Problems []Problem

+ State EntityState

+ type ItemSpec struct

+ Description string

+ Hidden bool

+ Key string

+ ManualStart bool

+ Name string

+ Order int

+ type JSONAction struct

+ Command *JSONCommand

+ Label string

+ URL string

+ type JSONChanges struct

+ ID string

+ Records []JSONEffectRecord

+ Subject string

+ type JSONCollection struct

+ Children []string

+ ID string

+ Name string

+ State EntityState

+ Summary string

+ type JSONCommand struct

+ Args []string

+ Executable string

+ type JSONDocument struct

+ Actions []JSONAction

+ Changes []JSONChanges

+ Conclusion ConclusionJSON

+ Items []JSONItem

+ Output JSONOutputMeta

+ Plans []JSONPlan

+ SchemaVersion string

+ TaskCollections []JSONCollection

+ Tasks []JSONTask

+ type JSONEffectRecord struct

+ Object string

+ Quantity *int64

+ Verb string

+ type JSONItem struct

+ Because string

+ ID string

+ Name string

+ Problems []JSONProblem

+ State EntityState

+ type JSONLOptions struct

+ type JSONOptions struct

+ type JSONOutputMeta struct

+ ID string

+ Subject string

+ type JSONPlan struct

+ ID string

+ Records []JSONEffectRecord

+ Subject string

+ type JSONProblem struct

+ Code string

+ Count int64

+ Detail string

+ Subject string

+ Summary string

+ Unit string

+ type JSONProgress struct

+ Completed int64

+ Kind ProgressKind

+ Total int64

+ type JSONTask struct

+ ID string

+ Name string

+ Phase string

+ Problems []JSONProblem

+ Progress *JSONProgress

+ State EntityState

+ Summary string

+ type LiveSurface interface

+ ClearLive func()

+ Columns func() int

+ IsInteractive func() bool

+ Rows func() int

+ WriteDurable func(line string)

+ WriteFinal func(text string)

+ WriteLive func(text string)

+ type Location struct

+ Column int

+ Line int

+ Path string

+ type LogLevel int

+ const LevelDebug

+ const LevelError

+ const LevelInfo

+ const LevelTrace

+ const LevelWarn

+ type NoopRedactor struct

+ func (NoopRedactor) RedactString(s string) string

+ type Option interface

+ func AlsoWrite(w io.Writer) Option

+ func Clock(ts TimeSource) Option

+ func DataProjection() Option

+ func DebugHistory() Option

+ func DebugLevel(level LogLevel) Option

+ func DebugPane(opts ...DebugPaneOption) Option

+ func Diagnostics(w io.Writer) Option

+ func ExternalProjection() Option

+ func MaxEntities(n int) Option

+ func MaxEvents(n int) Option

+ func MaxFrameRate(framesPerSecond int) Option

+ func NoColor() Option

+ func NonInteractive() Option

+ func Plain() Option

+ func Redact(r Redactor) Option

+ func Strict() Option

+ func Terminal(driver TerminalDriver) Option

+ func To(w io.Writer) Option

+ func VisibilityDelay(delay time.Duration) Option

+ func Width(columns int) Option

+ func WriterOptions(w io.Writer, extra ...Option) []Option

+ type Output struct

+ func For(subject string, options ...Option) *Output

+ func New(options ...Option) *Output

+ func NewWithConfig(cfg Config) (*Output, error)

+ func (o *Output) AnyBlocked() bool

+ func (o *Output) AnyFailed() bool

+ func (o *Output) Cancel(reason string)

+ func (o *Output) Changes(subject string) *Changes

+ func (o *Output) Close() error

+ func (o *Output) Conclusion() Conclusion

+ func (o *Output) Debug(message string, fields ...Field)

+ func (o *Output) DebugWriter() io.WriteCloser

+ func (o *Output) Err() error

+ func (o *Output) ErrorMessage(message string, _ ...Field)

+ func (o *Output) Events() []Event

+ func (o *Output) Explain(text string)

+ func (o *Output) Fail(summary string, options ...ProblemOption)

+ func (o *Output) FinalPlain() string

+ func (o *Output) Finish() error

+ func (o *Output) Info(message string, _ ...Field)

+ func (o *Output) Item(name string) *Item

+ func (o *Output) ItemWith(spec ItemSpec) (*Item, error)

+ func (o *Output) Line(message string)

+ func (o *Output) Linef(format string, args ...any)

+ func (o *Output) Next(actions ...Action)

+ func (o *Output) NextCommand(executable string, args ...string)

+ func (o *Output) Plan(subject string) *Plan

+ func (o *Output) SlogHandler(min slog.Leveler) slog.Handler

+ func (o *Output) Snapshot() Snapshot

+ func (o *Output) Snapshots() <-chan Snapshot

+ func (o *Output) Suspend(fn func() error) error

+ func (o *Output) Task(name string) *Task

+ func (o *Output) Tasks(name string) *Tasks

+ func (o *Output) WarnMessage(message string, _ ...Field)

+ type PlainOptions struct

+ NoColor bool

+ NonInteractive bool

+ Width int

+ type Plan struct

+ func (p *Plan) Add(quantity int64, object string) *Plan

+ func (p *Plan) Create(object string) *Plan

+ func (p *Plan) Delete(quantity int64, object string) *Plan

+ func (p *Plan) Move(source, destination string) *Plan

+ func (p *Plan) Record(verb string, quantity int64, object string) *Plan

+ func (p *Plan) Remove(quantity int64, object string) *Plan

+ func (p *Plan) Retain(description string) *Plan

+ func (p *Plan) Revoke(quantity int64, object string) *Plan

+ func (p *Plan) Update(quantity int64, object string) *Plan

+ func (p *Plan) Write(object string) *Plan

+ type PlanSnapshot struct

+ ID string

+ Records []EffectRecord

+ Subject string

+ type Problem struct

+ Actions []Action

+ Cause error

+ Code string

+ Count int64

+ Detail string

+ Evidence []Evidence

+ Fields []Field

+ Location *Location

+ Sensitive bool

+ Severity string

+ Subject string

+ Summary string

+ Unit string

+ type ProblemOption interface

+ func At(path string, line, column int) ProblemOption

+ func Cause(err error) ProblemOption

+ func Code(value string) ProblemOption

+ func Count(value int64, unit ...string) ProblemOption

+ func Detail(text string) ProblemOption

+ func Next(action Action) ProblemOption

+ func NextCommand(executable string, args ...string) ProblemOption

+ func On(subject string) ProblemOption

+ type Progress struct

+ Completed int64

+ Kind ProgressKind

+ Total int64

+ type ProgressKind string

+ const BytesKind

+ const Determinate

+ const Indeterminate

+ type ProjectionPolicy int

+ const ProjectionAuto

+ const ProjectionData

+ const ProjectionExternal

+ const ProjectionHuman

+ type Redactor interface

+ RedactString func(s string) string

+ type Snapshot struct

+ Actions []Action

+ Changes []ChangesSnapshot

+ Collections []TasksSnapshot

+ Conclusion *Conclusion

+ Items []ItemSnapshot

+ Lines []string

+ OutputID string

+ Plans []PlanSnapshot

+ Subject string

+ Tasks []TaskSnapshot

+ Timestamp time.Time

+ Version uint64

+ type SystemClock struct

+ func (SystemClock) Now() time.Time

+ type Task struct

+ func (t *Task) Advance(delta int64) *Task

+ func (t *Task) Bytes(completed, total int64) *Task

+ func (t *Task) Cancel(reason string) *Task

+ func (t *Task) Done() *Task

+ func (t *Task) Donef(format string, args ...any) *Task

+ func (t *Task) Fail(summary string, options ...ProblemOption) *Task

+ func (t *Task) Next(actions ...Action) *Task

+ func (t *Task) NextCommand(executable string, args ...string) *Task

+ func (t *Task) Phase(text string) *Task

+ func (t *Task) Progress(completed, total int64) *Task

+ func (t *Task) Skip(reason string) *Task

+ func (t *Task) Snapshot() TaskSnapshot

+ func (t *Task) Warn(summary string, options ...ProblemOption) *Task

+ type TaskSnapshot struct

+ Actions []Action

+ Collection string

+ Declaration int

+ ID string

+ Name string

+ Phase string

+ Problems []Problem

+ Progress Progress

+ State EntityState

+ Summary string

+ type Tasks struct

+ func (g *Tasks) Snapshot() TasksSnapshot

+ func (g *Tasks) Summary(text string) *Tasks

+ func (g *Tasks) Summaryf(format string, args ...any) *Tasks

+ func (g *Tasks) Task(name string) *Task

+ type TasksSnapshot struct

+ Declaration int

+ ID string

+ Name string

+ State EntityState

+ Summary string

+ Tasks []TaskSnapshot

+ type TerminalDriver interface

+ ID func() string

+ type TimeSource interface

+ Now func() time.Time

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