cli

package

v1.9.14 Latest Latest Go to latest Published: Nov 18, 2025 License: Apache-2.0 Imports: 19 Imported by: 0

Details

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

Repository

github.com/docker/cagent

Links

Documentation ¶

Index ¶

func Run(ctx context.Context, out *Printer, cfg Config, agentFilename string, ...) error
type Config
type ConfirmationResult
type Printer
- func NewPrinter(out io.Writer) *Printer
type RuntimeError
- func (e RuntimeError) Error() string
- func (e RuntimeError) Unwrap() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(ctx context.Context, out *Printer, cfg Config, agentFilename string, rt runtime.Runtime, sess *session.Session, args []string) error

Run executes an agent in non-TUI mode, handling user input and runtime events

Types ¶

type Config ¶

type Config struct {
	AppName        string
	AttachmentPath string
}

Config holds configuration for running an agent in CLI mode

type ConfirmationResult ¶

type ConfirmationResult string

ConfirmationResult represents the result of a user confirmation prompt

const (
	ConfirmationApprove        ConfirmationResult = "approve"
	ConfirmationApproveSession ConfirmationResult = "approve_session"
	ConfirmationReject         ConfirmationResult = "reject"
	ConfirmationAbort          ConfirmationResult = "abort"
)

type Printer ¶ added in v1.9.8

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

func NewPrinter ¶ added in v1.9.8

func NewPrinter(out io.Writer) *Printer

func (*Printer) Print ¶ added in v1.9.8

func (p *Printer) Print(a ...any)

func (*Printer) PrintAgentName ¶ added in v1.9.8

func (p *Printer) PrintAgentName(agentName string)

PrintAgentName prints the agent name header

func (*Printer) PrintError ¶ added in v1.9.8

func (p *Printer) PrintError(err error)

PrintError prints an error message

func (*Printer) PrintToolCall ¶ added in v1.9.8

func (p *Printer) PrintToolCall(toolCall tools.ToolCall)

PrintToolCall prints a tool call

func (*Printer) PrintToolCallResponse ¶ added in v1.9.8

func (p *Printer) PrintToolCallResponse(toolCall tools.ToolCall, response string)

PrintToolCallResponse prints a tool call response

func (*Printer) PrintToolCallWithConfirmation ¶ added in v1.9.8

func (p *Printer) PrintToolCallWithConfirmation(ctx context.Context, toolCall tools.ToolCall, rd io.Reader) ConfirmationResult

PrintToolCallWithConfirmation prints a tool call and prompts for confirmation

func (*Printer) PrintWelcomeMessage ¶ added in v1.9.8

func (p *Printer) PrintWelcomeMessage(appName string)

PrintWelcomeMessage prints the welcome message

func (*Printer) Printf ¶ added in v1.9.8

func (p *Printer) Printf(format string, a ...any) (n int, err error)

func (*Printer) Println ¶ added in v1.9.8

func (p *Printer) Println(a ...any)

func (*Printer) PromptMaxIterationsContinue ¶ added in v1.9.8

func (p *Printer) PromptMaxIterationsContinue(ctx context.Context, maxIterations int) ConfirmationResult

PromptMaxIterationsContinue prompts the user to continue after max iterations

func (*Printer) PromptOAuthAuthorization ¶ added in v1.9.8

func (p *Printer) PromptOAuthAuthorization(ctx context.Context, serverURL string) ConfirmationResult

PromptOAuthAuthorization prompts the user for OAuth authorization

type RuntimeError ¶

type RuntimeError struct {
	Err error
}

RuntimeError wraps runtime errors to distinguish them from usage errors

func (RuntimeError) Error ¶

func (e RuntimeError) Error() string

func (RuntimeError) Unwrap ¶

func (e RuntimeError) Unwrap() error

Source Files ¶

View all Source files

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