engine

Documentation

Index

• Constants
• func CombineStreams(stdout, stderr string) string
• func SanitizeFileName(value string) string
• type Engine
  • func New(cfg config.Config, paths config.Paths, store *history.Store, ...) *Engine
  • func (e *Engine) Execute(ctx context.Context, inv Invocation, passthrough bool) (Result, error)
  • func (e *Engine) ExecuteStreaming(ctx context.Context, inv Invocation, passthrough bool, ...) (Result, error)
  • func (e *Engine) Explain(inv Invocation) Profile
  • func (e *Engine) ExplainDecisions(inv Invocation) []ExplainDecision
  • func (e *Engine) ExplainPreferences(inv Invocation) (Invocation, []PreferenceDecision)
  • func (e *Engine) Profiles() []Profile
• type Execution
• type ExplainDecision
• type FastPathDecision
  • func DecideFastPath(profile Profile, rawBytes, rawTokens int, duration time.Duration, exitCode int) FastPathDecision
• type Invocation
• type OutputBudget
  • func ExpandBudgetForFailureEscape(budget OutputBudget, inv Invocation) OutputBudget
  • func ResolveBudget(profile Profile, inv Invocation, fallbackLines int) OutputBudget
• type PartialResult
• type PreferenceDecision
• type Profile
• type RenderedExecution
  • func RenderExecution(profile Profile, inv Invocation, exec Execution, fallbackLines int, ...) RenderedExecution
• type Result
• type StreamReducer
• type StreamReducerDone
• type StreamReducerPreview
• type StreamRenderFactory

Constants

const (
	ConfidenceHigh   = "high"
	ConfidenceMedium = "medium"
	ConfidenceLow    = "low"
)

const (
	SourceBuiltin    = "built-in"
	SourceProject    = "project-local"
	SourcePreference = "project-preference"
	SourceFallback   = "fallback"
)

const (
	StreamAuto        = "auto"
	StreamStdoutOnly  = "stdout-only"
	StreamStderrOnly  = "stderr-only"
	StreamStdoutFirst = "stdout-first"
	StreamStderrFirst = "stderr-first"
)

Functions

func CombineStreams

func CombineStreams(stdout, stderr string) string

func SanitizeFileName

func SanitizeFileName(value string) string

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func New

func New(cfg config.Config, paths config.Paths, store *history.Store, profiles []Profile) *Engine

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, inv Invocation, passthrough bool) (Result, error)

func (*Engine) ExecuteStreaming

func (e *Engine) ExecuteStreaming(
	ctx context.Context,
	inv Invocation,
	passthrough bool,
	onPartial func(PartialResult),
) (Result, error)

func (*Engine) Explain

func (e *Engine) Explain(inv Invocation) Profile

func (*Engine) ExplainDecisions

func (e *Engine) ExplainDecisions(inv Invocation) []ExplainDecision

func (*Engine) ExplainPreferences

func (e *Engine) ExplainPreferences(inv Invocation) (Invocation, []PreferenceDecision)

func (*Engine) Profiles

func (e *Engine) Profiles() []Profile

type Execution

type Execution struct {
	Command  []string
	Stdout   string
	Stderr   string
	ExitCode int
	Duration time.Duration
}

type ExplainDecision

type ExplainDecision struct {
	Name        string
	Description string
	Source      string
	Selected    bool
	Explain     []string
}

type FastPathDecision

type FastPathDecision struct {
	BypassCompression bool
	Reason            string
	WarnLatency       bool
}

func DecideFastPath

func DecideFastPath(profile Profile, rawBytes, rawTokens int, duration time.Duration, exitCode int) FastPathDecision

type Invocation

type Invocation struct {
	Command             []string
	Display             []string
	Cwd                 string
	Verbose             int
	UltraCompact        bool
	ReasoningBudgetMode string
}

type OutputBudget

type OutputBudget struct {
	MaxLines    int
	MaxBytes    int
	MaxTokens   int
	MinFailures int
	MinAnchors  int
	MinHints    int
}

func ExpandBudgetForFailureEscape

func ExpandBudgetForFailureEscape(budget OutputBudget, inv Invocation) OutputBudget

func ResolveBudget

func ResolveBudget(profile Profile, inv Invocation, fallbackLines int) OutputBudget

type PartialResult

type PartialResult struct {
	ProfileName       string
	ProfileConfidence string
	Display           string
	BytesParsed       int
	Final             bool
}

type PreferenceDecision

type PreferenceDecision struct {
	Name             string
	Description      string
	Source           string
	Applied          bool
	EffectiveCommand []string
	Explain          []string
}

type Profile

type Profile struct {
	Name             string
	Description      string
	Source           string
	Confidence       string
	StreamPreference string
	Budget           OutputBudget
	LatencyBudget    time.Duration
	Match            func(Invocation) bool
	Prepare          func(Invocation) []string
	Render           func(Invocation, Execution) string
	StreamRender     StreamRenderFactory
	ParseBytes       func(Execution) int
	Explain          []string
}

type RenderedExecution

type RenderedExecution struct {
	Text           string
	RawCombined    string
	BytesParsed    int
	BytesEmitted   int
	RawTokens      int
	FilteredTokens int
	FallbackUsed   bool
}

func RenderExecution

func RenderExecution(profile Profile, inv Invocation, exec Execution, fallbackLines int, passthrough bool) RenderedExecution

type Result

type Result struct {
	ProfileName       string
	ProfileConfidence string
	Display           string
	RawCombined       string
	ExitCode          int
	TeePath           string
	Duration          time.Duration
	FallbackUsed      bool
	BypassReason      string
	LatencyWarning    bool
	RawBytesRead      int
	BytesParsed       int
	BytesEmitted      int
}

type StreamReducer

type StreamReducer interface {
	ConsumeStdout([]byte)
	ConsumeStderr([]byte)
	Result() string
	BytesParsed() int
	FallbackUsed() bool
}

type StreamReducerDone

type StreamReducerDone interface {
	Done() bool
}

type StreamReducerPreview

type StreamReducerPreview interface {
	Preview() string
}

type StreamRenderFactory

type StreamRenderFactory func(Invocation, OutputBudget) StreamReducer