explain

Documentation

Overview

internal/explain/explain.go

Index

• func Run(ctx context.Context, cfg Config) (string, error)
• type Config
• type Runner
• type RunnerFunc
  • func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)

Functions

func Run

func Run(ctx context.Context, cfg Config) (string, error)

Run explains code in the configured mode using the runner.

Types

type Config

type Config struct {
	// file mode
	File   string
	Path   string
	Symbol string

	// diff mode
	Diff string
	Log  string
	Stat string

	Runner Runner
}

Config holds inputs for an explain run. File mode: set File and Path (Symbol optional). Diff mode: set Diff (Log and Stat optional). Exactly one mode must be active; Run returns an error otherwise.

type Runner

type Runner interface {
	Run(ctx context.Context, prompt string, tools []string) (string, error)
}

Runner is the port for LLM calls.

type RunnerFunc

type RunnerFunc func(ctx context.Context, prompt string, tools []string) (string, error)

RunnerFunc is a function adapter for Runner.

func (RunnerFunc) Run

func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)