Documentation
¶
Overview ¶
Package explain generates human-readable pre-execution narrations of task plans. For each pending task (or a specific task), it asks the AI provider to narrate what the task will do: estimated files to touch, commands likely to run, risks, and success criteria. The output is a numbered list per task with a final summary.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Explain ¶
func Explain(ctx context.Context, p provider.Provider, model string, plan *pm.Plan, taskID string) (string, error)
Explain generates a narration of what the given tasks will do.
If taskID is non-empty it must be a numeric task ID; only that task is narrated. If taskID is empty, all pending tasks are narrated. model may be empty (the provider will use its default).
The returned string is a formatted, human-readable walkthrough suitable for printing directly to a terminal.
Types ¶
This section is empty.
Source Files