engine

Documentation

Index

• Variables
• func Run(opts Options) error
• type Options

Variables

var ErrInterrupted = fmt.Errorf("interrupted")

ErrInterrupted is returned when the engine is stopped by a user signal (Ctrl+C).

Functions

func Run

func Run(opts Options) error

Run executes the loop until completion, max iterations, or interrupt.

Types

type Options

type Options struct {
	Prompt  string   // resolved prompt text
	Max     int      // max iterations (0 = unlimited)
	Command []string // command + args to run (prompt piped to stdin)
}

Options configures a loop run.