opencode

package module

Go to main page

Versions in this module

v0

v0.3.2

Jul 26, 2026

v0.3.1

Jul 25, 2026

v0.3.0

Jul 25, 2026

Changes in this version

type HighEvent

+ func (e HighEvent) ModelID() string

+ func (e HighEvent) ProviderID() string

+ func (e HighEvent) ReasoningTokens() int

+ func (e HighEvent) SessionCost() float64

+ func (e HighEvent) SessionTokens() SessionTokens

type MessageInfo

+ ModelID string

+ ProviderID string

v0.2.1

Jul 25, 2026

Changes in this version

type HighEvent

+ func (e HighEvent) Thinking() string

type HighEventKind

+ const HighEventThinkingDone

v0.2.0

Jul 25, 2026

Changes in this version

type Client

+ func (c *Client) RunWithHandle(ctx context.Context, stream *GlobalEventStream, opts RunOptions) (*RunHandle, error)

type GlobalEventStream

+ OnIdle func(sessionID string, idleSince time.Time)

type Option

+ func WithBusinessIdleTimeout(d time.Duration) Option

+ func WithDrainGrace(d time.Duration) Option

+ func WithLogger(l *slog.Logger) Option

+ type RunHandle struct

+ func (h *RunHandle) Events() <-chan HighEvent

+ func (h *RunHandle) WaitTerminal(ctx context.Context) (HighEvent, bool)

v0.1.1

Jul 24, 2026

Changes in this version

type Client

+ func (c *Client) ListChildren(ctx context.Context, sessionID, directory string) ([]SessionInfo, error)

v0.1.0

Jul 24, 2026

v0.0.8

Jul 24, 2026

Changes in this version

type Client

+ func (c *Client) ListTodos(ctx context.Context, sessionID string) ([]Todo, error)

type HighEvent

+ func (e HighEvent) TodoUpdated() *TodoUpdatedData

type HighEventKind

+ const HighEventTodoUpdated

type HighEventOpt

+ func WithPermissionAsked(d *PermissionAskedData) HighEventOpt

+ func WithQuestionAsked(d *QuestionAskedData) HighEventOpt

+ func WithTodoUpdated(d *TodoUpdatedData) HighEventOpt

v0.0.7

Jul 24, 2026

v0.0.6

Jul 23, 2026

Changes in this version

type SessionMessage

+ func (m SessionMessage) ReasoningText() string

v0.0.5

Jul 22, 2026

v0.0.4

Jul 22, 2026

v0.0.3

Jul 22, 2026

v0.0.2

Jul 22, 2026

Changes in this version

type HighEvent

+ func (e HighEvent) PermissionAsked() *PermissionAskedData

+ func (e HighEvent) QuestionAsked() *QuestionAskedData

type HighEventKind

+ const HighEventPermissionAsked

+ const HighEventQuestionAsked

type PermissionAskedData

+ Tool *PermissionTool

v0.0.1

Jul 21, 2026

Changes in this version

+ const EventCatalogUpdated

+ const EventCommandExecuted

+ const EventFileEdited

+ const EventFileWatcherUpdated

+ const EventGlobalDisposed

+ const EventInstallationUpdateAvail

+ const EventInstallationUpdated

+ const EventIntegrationConnUpdated

+ const EventIntegrationUpdated

+ const EventLspUpdated

+ const EventMcpBrowserOpenFailed

+ const EventMcpToolsChanged

+ const EventMessagePartDelta

+ const EventMessagePartRemoved

+ const EventMessagePartUpdated

+ const EventMessageRemoved

+ const EventMessageUpdated

+ const EventModelsDevRefreshed

+ const EventPermissionAsked

+ const EventPermissionReplied

+ const EventPluginAdded

+ const EventProjectDirectoriesUpdated

+ const EventProjectUpdated

+ const EventPtyCreated

+ const EventPtyDeleted

+ const EventPtyExited

+ const EventPtyUpdated

+ const EventQuestionAsked

+ const EventQuestionRejected

+ const EventQuestionReplied

+ const EventReferenceUpdated

+ const EventServerConnected

+ const EventSessionCompacted

+ const EventSessionCreated

+ const EventSessionDeleted

+ const EventSessionDiff

+ const EventSessionError

+ const EventSessionIdle

+ const EventSessionStatus

+ const EventSessionUpdated

+ const EventTodoUpdated

+ const EventTuiCommandExecute

+ const EventTuiPromptAppend

+ const EventTuiSessionSelect

+ const EventTuiToastShow

+ const EventVcsBranchUpdated

+ const EventWorkspaceFailed

+ const EventWorkspaceReady

+ const EventWorkspaceStatus

+ const EventWorktreeFailed

+ const EventWorktreeReady

+ const PartTypeReasoning

+ const PartTypeStepFinish

+ const PartTypeStepStart

+ const PartTypeText

+ const PartTypeTool

+ const PermissionReplyAlways

+ const PermissionReplyOnce

+ const PermissionReplyReject

+ func GenerateMessageID() (string, error)

+ func GeneratePartID() (string, error)

+ type APIError struct

+ Message string

+ Status int

+ Type string

+ func (e *APIError) Error() string

+ type AgentInfo struct

+ Color string

+ Description string

+ Hidden bool

+ Mode string

+ Model *ModelRef

+ Name string

+ Native bool

+ Options json.RawMessage

+ Permission json.RawMessage

+ Prompt string

+ Steps int

+ Variant string

+ func (a *AgentInfo) UnmarshalJSON(data []byte) error

+ type Client struct

+ func New(baseURL string, opts ...Option) (*Client, error)

+ func (c *Client) CreateSession(ctx context.Context, req *CreateSessionReq) (*SessionInfo, error)

+ func (c *Client) DeleteSession(ctx context.Context, sessionID string) error

+ func (c *Client) DeleteSessionIfIdle(ctx context.Context, sessionID string) error

+ func (c *Client) GetMessage(ctx context.Context, sessionID, messageID string) (*SessionMessage, error)

+ func (c *Client) GetProvider(ctx context.Context, providerID string, loc *LocationRef) (*ProviderInfo, error)

+ func (c *Client) GetSession(ctx context.Context, sessionID string) (*SessionInfo, error)

+ func (c *Client) Health(ctx context.Context) error

+ func (c *Client) Interrupt(ctx context.Context, sessionID string) error

+ func (c *Client) ListAgents(ctx context.Context, loc *LocationRef) ([]AgentInfo, error)

+ func (c *Client) ListCommands(ctx context.Context, loc *LocationRef) ([]CommandInfo, error)

+ func (c *Client) ListConnectedProviders(ctx context.Context) ([]string, error)

+ func (c *Client) ListMessages(ctx context.Context, sessionID string, opt *ListMessagesOpt) ([]SessionMessage, error)

+ func (c *Client) ListModels(ctx context.Context, loc *LocationRef) ([]ModelInfo, error)

+ func (c *Client) ListPermissions(ctx context.Context, sessionID string) ([]PermissionRequest, error)

+ func (c *Client) ListProviders(ctx context.Context, loc *LocationRef) ([]ProviderInfo, error)

+ func (c *Client) ListQuestions(ctx context.Context, sessionID string) ([]QuestionRequest, error)

+ func (c *Client) ListSessions(ctx context.Context, opt *ListSessionsOpt) ([]SessionInfo, error)

+ func (c *Client) ListSkills(ctx context.Context, loc *LocationRef) ([]SkillInfo, error)

+ func (c *Client) NewGlobalEventStream(ctx context.Context, loc *LocationRef) (*GlobalEventStream, error)

+ func (c *Client) Prompt(ctx context.Context, sessionID string, req *PromptReq) (*PromptAck, error)

+ func (c *Client) RejectQuestion(ctx context.Context, requestID string) error

+ func (c *Client) ReplyPermission(ctx context.Context, requestID, reply, message string) error

+ func (c *Client) ReplyQuestion(ctx context.Context, requestID string, r *QuestionReply) error

+ func (c *Client) Run(ctx context.Context, stream *GlobalEventStream, opts RunOptions) (<-chan HighEvent, error)

+ func (c *Client) SessionEvents(ctx context.Context, sessionID string, opt *SessionEventsOpt) (<-chan Event, <-chan error)

+ func (c *Client) SessionStatuses(ctx context.Context) (map[string]SessionStatus, error)

+ func (c *Client) UpdateSession(ctx context.Context, sessionID string, req *UpdateSessionReq) (*SessionInfo, error)

+ type CommandInfo struct

+ Agent string

+ Description string

+ Hints []string

+ Model string

+ Name string

+ Source string

+ Subtask bool

+ Template string

+ type CreateSessionReq struct

+ Agent string

+ Directory string

+ Metadata map[string]any

+ Model *ModelRef

+ ParentID string

+ Permission []PermissionRule

+ Title string

+ WorkspaceID string

+ type Event struct

+ ID string

+ Properties json.RawMessage

+ Type string

+ type GlobalEventStream struct

+ func (s *GlobalEventStream) Close() error

+ func (s *GlobalEventStream) Subscribe(sessionID string) <-chan Event

+ func (s *GlobalEventStream) Unsubscribe(sessionID string)

+ type HighEvent struct

+ func NewHighEvent(kind HighEventKind, sessionID, messageID string, opts ...HighEventOpt) HighEvent

+ func (e HighEvent) CacheRead() int

+ func (e HighEvent) CacheWrite() int

+ func (e HighEvent) Cost() float64

+ func (e HighEvent) InputTokens() int

+ func (e HighEvent) IsError() bool

+ func (e HighEvent) IsToolError() bool

+ func (e HighEvent) Kind() HighEventKind

+ func (e HighEvent) MessageID() string

+ func (e HighEvent) OutputTokens() int

+ func (e HighEvent) Result() string

+ func (e HighEvent) SessionID() string

+ func (e HighEvent) Text() string

+ func (e HighEvent) ToolInput() string

+ func (e HighEvent) ToolKind() ToolKind

+ func (e HighEvent) ToolName() string

+ type HighEventKind string

+ const HighEventError

+ const HighEventPrompt

+ const HighEventResult

+ const HighEventStepFinish

+ const HighEventStepStart

+ const HighEventText

+ const HighEventThinking

+ const HighEventToolResult

+ const HighEventToolUse

+ type HighEventOpt func(*HighEvent)

+ func WithCost(c float64) HighEventOpt

+ func WithError() HighEventOpt

+ func WithResult(s string) HighEventOpt

+ func WithText(s string) HighEventOpt

+ func WithTokens(in, out, cacheRead, cacheWrite int) HighEventOpt

+ func WithTool(name, input string) HighEventOpt

+ func WithToolError() HighEventOpt

+ type ListMessagesOpt struct

+ Before string

+ Directory string

+ Limit int

+ Workspace string

+ type ListSessionsOpt struct

+ Directory string

+ Limit int

+ Scope string

+ Search string

+ Workspace string

+ type LocationRef struct

+ Directory string

+ WorkspaceID string

+ type MessageInfo struct

+ Agent string

+ Cost float64

+ Finish string

+ ID string

+ Role string

+ SessionID string

+ Tokens SessionTokens

+ type MessageUpdatedData struct

+ Info MessageInfo

+ SessionID string

+ type ModelAPI struct

+ ID string

+ NPM string

+ URL string

+ type ModelCapabilities struct

+ Attachment bool

+ Input map[string]bool

+ Output map[string]bool

+ Reasoning bool

+ Temperature bool

+ Toolcall bool

+ type ModelCost struct

+ Cache struct{ ... }

+ Input float64

+ Output float64

+ type ModelInfo struct

+ API ModelAPI

+ Capabilities ModelCapabilities

+ Cost ModelCost

+ Enabled bool

+ Family string

+ Headers map[string]string

+ ID string

+ Limit ModelLimit

+ Name string

+ Options map[string]any

+ ProviderID string

+ ReleaseDate string

+ Status string

+ Variants json.RawMessage

+ type ModelLimit struct

+ Context int

+ Input int

+ Output int

+ type ModelRef struct

+ ID string

+ ProviderID string

+ Variant string

+ type Option func(*Client)

+ func WithBasicAuth(user, pass string) Option

+ func WithHTTPClient(h *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithPassword(pass string) Option

+ func WithToken(token string) Option

+ func WithUserAgent(ua string) Option

+ type Part struct

+ CallID string

+ Cost float64

+ ID string

+ Ignored bool

+ MessageID string

+ Reason string

+ SessionID string

+ State *ToolState

+ Synthetic bool

+ Text string

+ Tokens StepTokens

+ Tool string

+ Type string

+ type PartDeltaData struct

+ Delta string

+ Field string

+ MessageID string

+ PartID string

+ SessionID string

+ type PartUpdatedData struct

+ Part Part

+ SessionID string

+ Time int64

+ type PermissionAskedData struct

+ Always []string

+ ID string

+ Metadata map[string]any

+ Patterns []string

+ Permission string

+ SessionID string

+ type PermissionRequest struct

+ Always []string

+ ID string

+ Metadata map[string]any

+ Patterns []string

+ Permission string

+ SessionID string

+ Tool *PermissionTool

+ type PermissionRule struct

+ Action string

+ Pattern string

+ Permission string

+ type PermissionTool struct

+ CallID string

+ MessageID string

+ type PromptAck struct

+ MessageID string

+ PartIDs []string

+ type PromptModelRef struct

+ ModelID string

+ ProviderID string

+ type PromptPart struct

+ Filename string

+ ID string

+ Mime string

+ Text string

+ Type string

+ URL string

+ type PromptReq struct

+ Agent string

+ MessageID string

+ Model *ModelRef

+ NoReply bool

+ Parts []PromptPart

+ System string

+ Tools map[string]bool

+ Variant string

+ type ProviderInfo struct

+ Env []string

+ ID string

+ Models map[string]ModelInfo

+ Name string

+ Options map[string]any

+ Source string

+ type QuestionAskedData struct

+ ID string

+ Questions []QuestionInfo

+ SessionID string

+ Tool *QuestionTool

+ type QuestionInfo struct

+ Custom bool

+ Header string

+ Multiple bool

+ Options []QuestionOption

+ Question string

+ type QuestionOption struct

+ Description string

+ Label string

+ type QuestionReply struct

+ Answers [][]string

+ type QuestionRequest struct

+ ID string

+ Questions []QuestionInfo

+ SessionID string

+ Tool *QuestionTool

+ type QuestionTool struct

+ CallID string

+ MessageID string

+ type RevertState struct

+ Diff string

+ MessageID string

+ PartID string

+ Snapshot string

+ type RunOptions struct

+ Agent string

+ Location *LocationRef

+ Model *ModelRef

+ Prompt string

+ SessionID string

+ type SessionCache struct

+ Read float64

+ Write float64

+ type SessionErrorData struct

+ Error map[string]any

+ SessionID string

+ type SessionEventsOpt struct

+ BackoffMax time.Duration

+ BackoffMin time.Duration

+ Location *LocationRef

+ MaxAttempts int

+ type SessionIdleData struct

+ SessionID string

+ type SessionInfo struct

+ Agent string

+ Cost float64

+ Directory string

+ ID string

+ Metadata map[string]any

+ Model *ModelRef

+ ParentID string

+ Path string

+ Permission json.RawMessage

+ ProjectID string

+ Revert *RevertState

+ Share *SessionShare

+ Slug string

+ Summary *SessionSummary

+ Time SessionTime

+ Title string

+ Tokens SessionTokens

+ Version string

+ WorkspaceID string

+ type SessionMessage struct

+ Info MessageInfo

+ Parts []json.RawMessage

+ func (m SessionMessage) FinalText() string

+ type SessionShare struct

+ URL string

+ type SessionStatus struct

+ Type string

+ type SessionSummary struct

+ Additions float64

+ Deletions float64

+ Files float64

+ type SessionTime struct

+ Archived int64

+ Compacting int64

+ Created int64

+ Updated int64

+ type SessionTokens struct

+ Cache SessionCache

+ Input float64

+ Output float64

+ Reasoning float64

+ type SkillInfo struct

+ Content string

+ Description string

+ Location string

+ Name string

+ type StepCache struct

+ Read float64

+ Write float64

+ type StepTokens struct

+ Cache StepCache

+ Input float64

+ Output float64

+ Reasoning float64

+ type Todo struct

+ Content string

+ Priority string

+ Status string

+ type TodoUpdatedData struct

+ SessionID string

+ Todos []Todo

+ type ToolKind string

+ const ToolKindFileRead

+ const ToolKindFileWrite

+ const ToolKindMCP

+ const ToolKindOther

+ const ToolKindSearch

+ const ToolKindShell

+ const ToolKindSubagent

+ const ToolKindTodo

+ const ToolKindWebFetch

+ func ClassifyTool(name string) ToolKind

+ type ToolState struct

+ Error string

+ Input map[string]any

+ Output string

+ Status string

+ type UpdateSessionReq struct

+ Archived int64

+ Metadata map[string]any

+ Title string

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