Documentation
¶
Overview ¶
Package agent runs (agent) task bodies by driving an installed agent CLI (claude/codex/copilot/…) behind a vendor-neutral Provider interface (Principle VII / FR-030). The CLI owns its own authentication; no API keys are ever read from the Runefile.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthError ¶
AuthError reports that the agent CLI ran but failed, commonly because it is not authenticated.
type CLIProvider ¶
type CLIProvider struct{}
CLIProvider drives an installed agent CLI. It is the v1 concrete Provider.
type NotConfiguredError ¶
type NotConfiguredError struct{}
NotConfiguredError reports that no agent command is configured (never invent credentials, FR-027).
func (*NotConfiguredError) Error ¶
func (e *NotConfiguredError) Error() string
type NotInstalledError ¶
type NotInstalledError struct{ Name string }
NotInstalledError reports that the configured agent CLI is not on PATH.
func (*NotInstalledError) Error ¶
func (e *NotInstalledError) Error() string
type Options ¶
type Options struct {
AgentCmd []string // e.g. ["claude", "-p"]; the prompt is appended
AllowedTasks []string // tasks the agent may call back into (non-destructive by default)
MCPURL string // in-process MCP endpoint the agent can call (if any)
MCPToken string // bearer token for the MCP endpoint
Dir string
Env []string
Stdin io.Reader
Stderr io.Writer // agent progress/diagnostics stream here
}
Options configures an agent run.
type Provider ¶
type Provider interface {
Run(ctx context.Context, prompt string, opts Options) (finalText string, err error)
}
Provider runs a prompt and returns the agent's final text output. The interface stays vendor-neutral so a direct hosted-API provider can be added later without changing core.