ask

package

v0.1.1 Latest Latest Go to latest Published: Jun 7, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/elhenro/bee

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ask lets a tool pose a multiple-choice question to the user and block until they pick. Mirrors the approval gate: the TUI surfaces an interactive picker, headless runs auto-resolve so nothing ever hangs.

Pattern: the ask_user tool builds a Question -> Asker.Ask surfaces it -> the user picks an option or types their own -> the chosen Answer flows back.

Index ¶

type Answer
type Asker
type Option
type Question
type Static
- func (Static) Ask(_ context.Context, q Question) (Answer, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Answer ¶

type Answer struct {
	Index     int
	Text      string
	Dismissed bool
}

Answer is the user's pick. Index points at the chosen Option, or -1 when the user typed custom text or dismissed. Text holds the chosen label or the custom string.

type Asker ¶

type Asker interface {
	Ask(ctx context.Context, q Question) (Answer, error)
}

Asker surfaces a Question and blocks until the user answers. TUI shows a picker; headless returns the recommended option without prompting.

type Option ¶

type Option struct {
	Label       string
	Description string
	Recommended bool
}

Option is one selectable choice. Recommended marks the model's suggested pick so the UI can highlight it and headless runs can auto-select it.

type Question ¶

type Question struct {
	Header      string // short chip, e.g. "3D engine"
	Prompt      string // full question text
	Options     []Option
	AllowCustom bool
}

Question is a single prompt with its choices. AllowCustom adds an escape hatch so the user can answer with free text instead of any listed option.

type Static ¶

type Static struct{}

Static auto-resolves to the recommended option (or first) without prompting. Used for headless and autonomous runs where no human is present, so the tool never blocks the loop.

func (Static) Ask ¶

func (Static) Ask(_ context.Context, q Question) (Answer, error)

Ask returns the recommended option, falling back to the first. Empty option lists resolve as dismissed.

Source Files ¶

View all Source files

ask.go

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