engine

Aug 24, 2026

Changes in this version

type Session

+ func (s *Session) RequestSnapshots() (snapshot.SessionReader, error)

Aug 21, 2026

Changes in this version

type Event

+ PlanMode bool

+ TurnID string

type EventType

+ const PlanModeChanged

+ const TurnStarted

+ type PlanModeSnapshot struct

+ Active bool

type Session

+ func (s *Session) ExitPlanMode(ctx context.Context) error

+ func (s *Session) PlanMode() PlanModeSnapshot

+ func (s *Session) PlanModeActive() bool

+ func (s *Session) RequestSnapshot(providerRequestID string) (snapshot.Snapshot, error)

+ func (s *Session) SetPlanMode(ctx context.Context, active bool) error

+ func (s *Session) Todos() *TodoSnapshot

+ type TodoItem struct

+ Content string

+ Status string

+ type TodoSnapshot struct

+ Todos []TodoItem

Aug 16, 2026

Changes in this version

type Event

+ ProviderRequestID string

+ RunID string

type HistoryItem

+ RunID string

type Options

+ Recorder observability.Recorder

+ RequestSnapshots snapshot.Writer

+ SessionID string

Aug 12, 2026

Changes in this version

type Event

+ AssistantMessageID string

+ SentAt time.Time

+ UserMessageIDs []string

type HistoryItem

+ MessageID string

+ SentAt time.Time

type Options

+ AdditionalTools []tools.Tool

Aug 11, 2026

Changes in this version

type Options

+ MCPConfigPath string

Aug 10, 2026

Changes in this version

+ type ContextBreakdown struct

+ Messages int64

+ ProjectContext int64

+ Skills int64

+ SystemPrompt int64

+ SystemTools int64

type ContextUsage

+ Breakdown *ContextBreakdown

type Event

+ ContextUsage ContextUsage

type Options

+ PermissionMode permission.Mode

type Session

+ func (s *Session) SetPermissionMode(mode permission.Mode)

Aug 5, 2026

Changes in this version

type Event

+ Invocation *invocation.Record

type HistoryItem

+ Invocation *invocation.Record

type Options

+ PromptTemplateLoader func() []prompttemplate.Template

+ PromptTemplates []prompttemplate.Template

Jul 30, 2026

Changes in this version

+ var ErrBusy = errors.New("coding: a run is already in progress")

+ func IsNothingToCompact(err error) bool

+ type AttachedFile struct

+ Content string

+ type BackgroundTask struct

+ Command string

+ CompletedAt time.Time

+ Description string

+ ExitCode *int

+ ID string

+ OutputPath string

+ StartedAt time.Time

+ Status string

+ type CompactionResult struct

+ FirstKeptEntryID string

+ Model string

+ Provider string

+ ResponseID string

+ ResponseModel string

+ Summary string

+ Timestamp time.Time

+ TokensAfter int64

+ TokensBefore int64

+ Usage llm.Usage

+ type ContextUsage struct

+ ContextWindow int64

+ Measured bool

+ Model string

+ Provider string

+ UsedTokens int64

+ type Event struct

+ Automatic bool

+ BackgroundTask BackgroundTask

+ CompletedAt time.Time

+ Delta string

+ Error string

+ Files []File

+ FinalResponse bool

+ Images []llm.ImageContent

+ Model string

+ Provider string

+ QueueHandle QueueHandle

+ ResponseID string

+ ResponseModel string

+ StartedAt time.Time

+ Text string

+ Timestamp time.Time

+ ToolArgs any

+ ToolCallID string

+ ToolContentIndex int

+ ToolInputBytes int

+ ToolName string

+ ToolOutcome agent.ToolOutcome

+ ToolResult string

+ Type EventType

+ Usage llm.Usage

+ type EventType string

+ const CompactionCompleted

+ const CompactionFailed

+ const CompactionStarted

+ const MessageCompleted

+ const RunCompleted

+ const RunStarted

+ const TaskCompleted

+ const TaskStarted

+ const TextDelta

+ const ThinkingDelta

+ const ToolFinished

+ const ToolInputCompleted

+ const ToolInputDelta

+ const ToolInputStarted

+ const ToolStarted

+ const TurnDiscarded

+ const UserMessageCompleted

+ type File struct

+ MIMEType string

+ Name string

+ Size int

+ type HistoryItem struct

+ CompletedAt time.Time

+ Files []File

+ FinalResponse bool

+ Images []llm.ImageContent

+ Model string

+ Provider string

+ StartedAt time.Time

+ Text string

+ ToolArgs any

+ ToolCallID string

+ ToolName string

+ ToolOutcome agent.ToolOutcome

+ ToolResult string

+ Type HistoryItemType

+ Usage llm.Usage

+ type HistoryItemType string

+ const HistoryAssistant

+ const HistoryRun

+ const HistoryThinking

+ const HistoryToolCall

+ const HistoryToolResult

+ const HistoryUsage

+ const HistoryUser

+ type Options struct

+ Approver permission.Approver

+ Asker tools.Asker

+ Browser tools.BrowserController

+ Capabilities []capability.Definition

+ Compactor compaction.Compactor

+ Cwd string

+ DetailsStore transcript.DetailsStore

+ GetAPIKey func(provider string) string

+ Instructions string

+ MaxRetries *int

+ Model llm.Model

+ Policy permission.Policy

+ SkillLoader func() []skills.Skill

+ Skills []skills.Skill

+ Store transcript.Store

+ StreamFn agent.StreamFn

+ StreamOptions llm.StreamOptions

+ ThinkingLevel llm.ModelThinkingLevel

+ Tools []tools.Tool

+ type QueueHandle struct

+ type Session struct

+ func New(ctx context.Context, opts Options) (*Session, error)

+ func (s *Session) Abort()

+ func (s *Session) CancelQueuedMessage(handle QueueHandle) bool

+ func (s *Session) ClearQueuedMessages()

+ func (s *Session) Close()

+ func (s *Session) Compact(ctx context.Context, instructions string) (CompactionResult, error)

+ func (s *Session) ContextUsage() ContextUsage

+ func (s *Session) Continue(ctx context.Context) error

+ func (s *Session) Cwd() string

+ func (s *Session) Entries() []transcript.Entry

+ func (s *Session) FollowUp(text string, images ...llm.ImageContent) QueueHandle

+ func (s *Session) FollowUpWithFiles(text string, files []AttachedFile, images ...llm.ImageContent) QueueHandle

+ func (s *Session) History() []HistoryItem

+ func (s *Session) Messages() []agent.AgentMessage

+ func (s *Session) Prompt(ctx context.Context, text string, images ...llm.ImageContent) error

+ func (s *Session) PromptWithFiles(ctx context.Context, text string, files []AttachedFile, ...) error

+ func (s *Session) SetModel(model llm.Model)

+ func (s *Session) SetPermissionPolicy(policy permission.Policy)

+ func (s *Session) SetThinkingLevel(level llm.ModelThinkingLevel)

+ func (s *Session) Snapshot() agent.State

+ func (s *Session) Steer(text string, images ...llm.ImageContent) QueueHandle

+ func (s *Session) SteerWithFiles(text string, files []AttachedFile, images ...llm.ImageContent) QueueHandle

+ func (s *Session) StopTask(id string) error

+ func (s *Session) Subscribe(listener func(Event)) (unsubscribe func())

+ func (s *Session) TaskOutput(id string) (TaskOutput, error)

+ func (s *Session) Tasks() []BackgroundTask

+ type TaskOutput struct

+ Content string

+ Truncated bool