cli

package

v1.9.6 Latest Latest Go to latest Published: Oct 31, 2025 License: Apache-2.0 Imports: 17 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 ¶

Variables
func PrintAgentName(agentName string)
func PrintError(err error)
func PrintToolCall(toolCall tools.ToolCall, colorFunc ...func(format string, a ...any) string)
func PrintToolCallResponse(toolCall tools.ToolCall, response string)
func PrintWelcomeMessage(appName string)
func Run(ctx context.Context, cfg Config, agentFilename string, rt runtime.Runtime, ...) error
type Config
type ConfirmationResult
type RuntimeError
- func (e RuntimeError) Error() string
- func (e RuntimeError) Unwrap() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Blue   = blue
	Yellow = yellow
	Red    = red
	White  = white
	Green  = green
	Bold   = bold
)

Color formatting functions (exported for use by other packages)

Functions ¶

func PrintAgentName ¶

func PrintAgentName(agentName string)

PrintAgentName prints the agent name header

func PrintError ¶

func PrintError(err error)

PrintError prints an error message

func PrintToolCall ¶

func PrintToolCall(toolCall tools.ToolCall, colorFunc ...func(format string, a ...any) string)

PrintToolCall prints a tool call

func PrintToolCallResponse ¶

func PrintToolCallResponse(toolCall tools.ToolCall, response string)

PrintToolCallResponse prints a tool call response

func PrintWelcomeMessage ¶

func PrintWelcomeMessage(appName string)

PrintWelcomeMessage prints the welcome message

func Run ¶

func Run(ctx context.Context, 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"
)

func PrintToolCallWithConfirmation ¶

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

PrintToolCallWithConfirmation prints a tool call and prompts for confirmation

func PromptMaxIterationsContinue ¶

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

PromptMaxIterationsContinue prompts the user to continue after max iterations

func PromptOAuthAuthorization ¶

func 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