Skip to main content

Module types

Module types 

Source

Structs§

APIError
APIErrorData
Agent
AgentConfig
AgentModel
AgentPart
AgentPartInput
AgentPartInputSource
AgentV2Info
ApiAuth
AssistantMessage
AssistantMessagePath
AssistantMessageTime
AttachmentConfig
BadRequestError
BadRequestErrorData
CatalogUpdated
Command
CommandExecuted
CommandExecutedData
CommandV2Info
CompactionPart
Config
ConfigAgent
ConfigCommandValue
ConfigCompaction
ConfigEnterprise
ConfigExperimental
ConfigFormatterVariant1Value
ConfigLspVariant1ValueVariant0
ConfigLspVariant1ValueVariant1
ConfigMcpValueVariant2
ConfigMode
ConfigSkills
ConfigToolOutput
ConfigV2ExperimentalPolicy
ConfigV2ReferenceGit
ConfigV2ReferenceLocal
ConfigWatcher
ConflictError
ConnectionCredentialInfo
ConnectionEnvInfo
ConsoleState
ContentFilterError
ContextOverflowError
ContextOverflowErrorData
CredentialKey
CredentialOAuth
EffectHttpApiErrorBadRequest
EffectHttpApiErrorForbidden
EffectHttpApiErrorInternalServerError
EventCatalogUpdated
EventCommandExecuted
EventFileEdited
EventFileWatcherUpdated
EventGlobalDisposed
EventInstallationUpdateAvailable
EventInstallationUpdated
EventIntegrationConnectionUpdated
EventIntegrationUpdated
EventLspUpdated
EventMcpBrowserOpenFailed
EventMcpToolsChanged
EventMessagePartDelta
EventMessagePartRemoved
EventMessagePartUpdated
EventMessageRemoved
EventMessageUpdated
EventModelsDevRefreshed
EventPermissionAsked
EventPermissionReplied
EventPermissionV2Asked
EventPermissionV2Replied
EventPluginAdded
EventProjectDirectoriesUpdated
EventProjectUpdated
EventPtyCreated
EventPtyDeleted
EventPtyExited
EventPtyUpdated
EventQuestionAsked
EventQuestionRejected
EventQuestionReplied
EventQuestionV2Asked
EventQuestionV2Rejected
EventQuestionV2Replied
EventReferenceUpdated
EventServerConnected
EventServerInstanceDisposed
EventServerInstanceDisposedProperties
EventSessionCompacted
EventSessionCreated
EventSessionDeleted
EventSessionDiff
EventSessionError
EventSessionIdle
EventSessionNextAgentSwitched
EventSessionNextCompactionDelta
EventSessionNextCompactionEnded
EventSessionNextCompactionStarted
EventSessionNextContextUpdated
EventSessionNextModelSwitched
EventSessionNextMoved
EventSessionNextPromptAdmitted
EventSessionNextPrompted
EventSessionNextReasoningDelta
EventSessionNextReasoningEnded
EventSessionNextReasoningStarted
EventSessionNextRetried
EventSessionNextRevertCleared
EventSessionNextRevertCommitted
EventSessionNextRevertStaged
EventSessionNextShellEnded
EventSessionNextShellStarted
EventSessionNextStepEnded
EventSessionNextStepFailed
EventSessionNextStepStarted
EventSessionNextSynthetic
EventSessionNextTextDelta
EventSessionNextTextEnded
EventSessionNextTextStarted
EventSessionNextToolCalled
EventSessionNextToolFailed
EventSessionNextToolInputDelta
EventSessionNextToolInputEnded
EventSessionNextToolInputStarted
EventSessionNextToolProgress
EventSessionNextToolSuccess
EventSessionStatus
EventSessionUpdated
EventTodoUpdated
EventTuiCommandExecute
EventTuiCommandExecute2
EventTuiPromptAppend
EventTuiPromptAppend2
EventTuiSessionSelect
EventTuiSessionSelect2
EventTuiToastShow
EventTuiToastShow2
EventVcsBranchUpdated
EventWorkspaceFailed
EventWorkspaceReady
EventWorkspaceStatus
EventWorktreeFailed
EventWorktreeReady
ExperimentalCapabilities
File
FileContent
FileContentPatch
FileContentPatchHunksItem
FileDiff
FileEdited
FileEditedData
FileNode
FilePart
FilePartInput
FilePartSourceText
FileSource
FileSystemEntry
FileWatcherUpdated
FileWatcherUpdatedData
ForbiddenError
FormatterStatus
GlobalDisposed
GlobalEvent
GlobalEventPayloadVariant0
GlobalEventPayloadVariant1
GlobalEventPayloadVariant2
GlobalEventPayloadVariant3
GlobalEventPayloadVariant4
GlobalEventPayloadVariant5
GlobalEventPayloadVariant6
GlobalEventPayloadVariant7
GlobalEventPayloadVariant8
GlobalEventPayloadVariant9
GlobalEventPayloadVariant10
GlobalEventPayloadVariant11
GlobalEventPayloadVariant12
GlobalEventPayloadVariant13
GlobalEventPayloadVariant14
GlobalEventPayloadVariant15
GlobalEventPayloadVariant16
GlobalEventPayloadVariant17
GlobalEventPayloadVariant18
GlobalEventPayloadVariant19
GlobalEventPayloadVariant20
GlobalEventPayloadVariant21
GlobalEventPayloadVariant22
GlobalEventPayloadVariant23
GlobalEventPayloadVariant24
GlobalEventPayloadVariant25
GlobalEventPayloadVariant26
GlobalEventPayloadVariant27
GlobalEventPayloadVariant28
GlobalEventPayloadVariant29
GlobalEventPayloadVariant30
GlobalEventPayloadVariant31
GlobalEventPayloadVariant32
GlobalEventPayloadVariant33
GlobalEventPayloadVariant34
GlobalEventPayloadVariant35
GlobalEventPayloadVariant36
GlobalEventPayloadVariant37
GlobalEventPayloadVariant38
GlobalEventPayloadVariant39
GlobalEventPayloadVariant40
GlobalEventPayloadVariant41
GlobalEventPayloadVariant42
GlobalEventPayloadVariant43
GlobalEventPayloadVariant44
GlobalEventPayloadVariant45
GlobalEventPayloadVariant46
GlobalEventPayloadVariant47
GlobalEventPayloadVariant48
GlobalEventPayloadVariant49
GlobalEventPayloadVariant50
GlobalEventPayloadVariant51
GlobalEventPayloadVariant52
GlobalEventPayloadVariant53
GlobalEventPayloadVariant54
GlobalEventPayloadVariant55
GlobalEventPayloadVariant56
GlobalEventPayloadVariant57
GlobalEventPayloadVariant58
GlobalEventPayloadVariant59
GlobalEventPayloadVariant60
GlobalEventPayloadVariant61
GlobalEventPayloadVariant62
GlobalEventPayloadVariant63
GlobalEventPayloadVariant64
GlobalEventPayloadVariant65
GlobalEventPayloadVariant66
GlobalEventPayloadVariant67
GlobalEventPayloadVariant68
GlobalEventPayloadVariant69
GlobalEventPayloadVariant70
GlobalEventPayloadVariant71
GlobalEventPayloadVariant72
GlobalEventPayloadVariant73
GlobalEventPayloadVariant74
GlobalEventPayloadVariant75
GlobalEventPayloadVariant76
GlobalEventPayloadVariant77
GlobalEventPayloadVariant78
GlobalEventPayloadVariant79
GlobalEventPayloadVariant80
GlobalEventPayloadVariant81
GlobalEventPayloadVariant82
GlobalEventPayloadVariant83
GlobalEventPayloadVariant84
GlobalEventPayloadVariant85
GlobalEventPayloadVariant86
GlobalEventPayloadVariant87
GlobalSession
ImageAttachmentConfig
InstallationUpdateAvailable
InstallationUpdated
InstallationUpdatedData
IntegrationAttempt
IntegrationAttemptStatusPendingTime
IntegrationConnectionUpdated
IntegrationConnectionUpdatedData
IntegrationEnvMethod
IntegrationInfo
IntegrationInputs
IntegrationKeyMethod
IntegrationOAuthMethod
IntegrationRef
IntegrationSelectPrompt
IntegrationTextPrompt
IntegrationUpdated
IntegrationWhen
InvalidCursorError
InvalidRequestError
JSONSchema
LLMProviderMetadata
LSPStatus
LocationInfo
LocationInfoProject
LocationRef
LspUpdated
MCPStatusConnected
MCPStatusDisabled
MCPStatusFailed
MCPStatusNeedsAuth
MCPStatusNeedsClientRegistration
McpBrowserOpenFailed
McpBrowserOpenFailedData
McpLocalConfig
McpOAuthConfig
McpRemoteConfig
McpResource
McpServerNotFoundError
McpToolsChanged
McpToolsChangedData
McpUnsupportedOAuthError
MessageAbortedError
MessageNotFoundError
MessageOutputLengthError
MessagePartDelta
MessagePartDeltaData
MessagePartRemoved
MessagePartRemovedData
MessagePartUpdated
MessagePartUpdatedData
MessageRemoved
MessageRemovedData
MessageUpdated
MessageUpdatedData
MessageWithParts
Model
ModelApi2
ModelCapabilities
ModelCapabilities2
ModelCapabilities2Input
ModelCost
ModelCost2
ModelCost2ExperimentalOver200K
ModelCost2TiersItem
ModelCost2TiersItemTier
ModelCostTier
ModelRef
ModelV2Info
ModelV2InfoLimit
ModelV2InfoRequest
ModelV2InfoTime
ModelV2InfoVariantsItem
ModelsDevRefreshed
MoveSessionDestination
MoveSessionError
NotFoundError
NotFoundErrorData
OAuth
OutputFormatJsonSchema
OutputFormatText
PatchPart
Path
PermissionAsked
PermissionAskedData
PermissionAskedDataTool
PermissionConfigVariant1
PermissionNotFoundError
PermissionObjectConfig
PermissionReplied
PermissionRepliedData
PermissionReplyParams
PermissionRequest
PermissionRule
PermissionSavedInfo
PermissionV2Asked
PermissionV2AskedData
PermissionV2Replied
PermissionV2RepliedData
PermissionV2Request
PermissionV2Rule
PermissionV2Source
PluginAdded
PluginAddedData
Project
ProjectCommands
ProjectCopyCopy
ProjectCopyError
ProjectCopyErrorData
ProjectDirectoriesItem
ProjectDirectoriesUpdated
ProjectDirectoriesUpdatedData
ProjectIcon
ProjectNotFoundError
ProjectSummary
ProjectTime
ProjectUpdated
ProjectUpdatedData
Prompt
PromptAgentAttachment
PromptAsyncParams
PromptFileAttachment
PromptInput
PromptInputFileAttachment
PromptSource
Provider
ProviderAISDK
ProviderAuthAuthorization
ProviderAuthError
ProviderAuthError1
ProviderAuthError1Data
ProviderAuthErrorData
ProviderAuthMethod
ProviderAuthMethodPromptsItemSelectOptionsItem
ProviderAuthMethodPromptsItemTextWhen
ProviderConfig
ProviderConfigModelsValue
ProviderConfigModelsValueCost
ProviderConfigModelsValueCostContextOver200k
ProviderConfigModelsValueInterleavedVariant1
ProviderConfigModelsValueLimit
ProviderConfigModelsValueModalities
ProviderConfigModelsValueProvider
ProviderConfigModelsValueVariantsValue
ProviderConfigOptions
ProviderNative
ProviderNotFoundError
ProviderRequest
ProviderV2Info
Pty
PtyCreated
PtyCreatedData
PtyDeleted
PtyDeletedData
PtyExited
PtyExitedData
PtyForbiddenError
PtyNotFoundError
PtyTicketConnectToken
PtyUpdated
QuestionAsked
QuestionAskedData
QuestionInfo
QuestionNotFoundError
QuestionOption
QuestionRejected
QuestionRejected2
QuestionRejected2Data
QuestionReplied
QuestionReplied2
QuestionReplied2Data
QuestionRequest
QuestionTool
QuestionV2Asked
QuestionV2AskedData
QuestionV2Info
QuestionV2Option
QuestionV2Rejected
QuestionV2Replied
QuestionV2RepliedData
QuestionV2Reply
QuestionV2Request
QuestionV2Tool
Range
RangeStart
ReasoningPart
ReferenceGitSource
ReferenceInfo
ReferenceLocalSource
ReferenceUpdated
ResourceSource
RetryPart
RetryPartTime
RevertState
ServerConfig
Server configuration for opencode serve and web commands
ServerConnected
ServiceUnavailableError
Session
SessionActive
SessionBusyError
SessionCompacted
SessionCreateParams
SessionCreateParamsModel
SessionCreated
SessionCreatedData
SessionDeleted
SessionDiff
SessionDiffData
SessionDurableEventStream
SessionError
SessionErrorData
SessionErrorUnknown
SessionHistory
SessionIdle
SessionIdleData
SessionInputAdmitted
SessionMessageAgentSwitched
SessionMessageAssistant
SessionMessageAssistantReasoning
SessionMessageAssistantSnapshot
SessionMessageAssistantText
SessionMessageAssistantTool
SessionMessageAssistantToolProvider
SessionMessageAssistantToolTime
SessionMessageCompaction
SessionMessageModelSwitched
SessionMessageShell
SessionMessageShellTime
SessionMessageSynthetic
SessionMessageSystem
SessionMessageToolStateCompleted
SessionMessageToolStateError
SessionMessageToolStatePending
SessionMessageToolStateRunning
SessionMessageUser
SessionMessageUserTime
SessionMessagesResponse
SessionNextAgentSwitched
SessionNextAgentSwitchedData
SessionNextCompactionDelta
SessionNextCompactionEnded
SessionNextCompactionEndedData
SessionNextCompactionStarted
SessionNextCompactionStartedData
SessionNextContextUpdated
SessionNextContextUpdatedData
SessionNextModelSwitched
SessionNextModelSwitchedData
SessionNextMoved
SessionNextMovedData
SessionNextPromptAdmitted
SessionNextPrompted
SessionNextPromptedData
SessionNextReasoningDelta
SessionNextReasoningDeltaData
SessionNextReasoningEnded
SessionNextReasoningEndedData
SessionNextReasoningStarted
SessionNextReasoningStartedData
SessionNextRetried
SessionNextRetriedData
SessionNextRetryError
SessionNextRevertCleared
SessionNextRevertClearedData
SessionNextRevertCommitted
SessionNextRevertCommittedData
SessionNextRevertStaged
SessionNextRevertStagedData
SessionNextShellEnded
SessionNextShellEndedData
SessionNextShellStarted
SessionNextShellStartedData
SessionNextStepEnded
SessionNextStepEndedData
SessionNextStepEndedDataTokens
SessionNextStepEndedDataTokensCache
SessionNextStepFailed
SessionNextStepFailedData
SessionNextStepStarted
SessionNextStepStartedData
SessionNextSynthetic
SessionNextTextDelta
SessionNextTextDeltaData
SessionNextTextEnded
SessionNextTextEndedData
SessionNextTextStarted
SessionNextTextStartedData
SessionNextToolCalled
SessionNextToolCalledData
SessionNextToolFailed
SessionNextToolFailedData
SessionNextToolFailedDataProvider
SessionNextToolInputDelta
SessionNextToolInputDeltaData
SessionNextToolInputEnded
SessionNextToolInputEndedData
SessionNextToolInputStarted
SessionNextToolInputStartedData
SessionNextToolProgress
SessionNextToolProgressData
SessionNextToolSuccess
SessionNextToolSuccessData
SessionNotFoundError
SessionRevert
SessionShare
SessionStatus2
SessionStatus2Data
SessionStatus2Durable
SessionStatusRetryAction
SessionSummary
SessionTime
SessionUpdated
SessionV2Info
SessionV2InfoTime
SessionsResponse
SessionsResponseCursor
SkillV2DirectorySource
SkillV2EmbeddedSource
SkillV2Info
SkillV2UrlSource
SnapshotFileDiff
SnapshotPart
StepFinishPart
StepFinishPartTokens
StepStartPart
StructuredOutputError
StructuredOutputErrorData
SubtaskPart
SubtaskPartInput
SubtaskPartInputModel
Symbol
SymbolLocation
SymbolSource
SyncEventMessagePartRemoved
SyncEventMessagePartRemovedSyncEvent
SyncEventMessagePartUpdated
SyncEventMessagePartUpdatedSyncEvent
SyncEventMessageRemoved
SyncEventMessageRemovedSyncEvent
SyncEventMessageUpdated
SyncEventMessageUpdatedSyncEvent
SyncEventSessionCreated
SyncEventSessionCreatedSyncEvent
SyncEventSessionDeleted
SyncEventSessionDeletedSyncEvent
SyncEventSessionNextAgentSwitched
SyncEventSessionNextAgentSwitchedSyncEvent
SyncEventSessionNextCompactionEnded
SyncEventSessionNextCompactionEndedSyncEvent
SyncEventSessionNextCompactionStarted
SyncEventSessionNextCompactionStartedSyncEvent
SyncEventSessionNextContextUpdated
SyncEventSessionNextContextUpdatedSyncEvent
SyncEventSessionNextModelSwitched
SyncEventSessionNextModelSwitchedSyncEvent
SyncEventSessionNextMoved
SyncEventSessionNextMovedSyncEvent
SyncEventSessionNextPromptAdmitted
SyncEventSessionNextPromptAdmittedSyncEvent
SyncEventSessionNextPrompted
SyncEventSessionNextPromptedSyncEvent
SyncEventSessionNextReasoningEnded
SyncEventSessionNextReasoningEndedSyncEvent
SyncEventSessionNextReasoningStarted
SyncEventSessionNextReasoningStartedSyncEvent
SyncEventSessionNextRetried
SyncEventSessionNextRetriedSyncEvent
SyncEventSessionNextRevertCleared
SyncEventSessionNextRevertClearedSyncEvent
SyncEventSessionNextRevertCommitted
SyncEventSessionNextRevertCommittedSyncEvent
SyncEventSessionNextRevertStaged
SyncEventSessionNextRevertStagedSyncEvent
SyncEventSessionNextShellEnded
SyncEventSessionNextShellEndedSyncEvent
SyncEventSessionNextShellStarted
SyncEventSessionNextShellStartedSyncEvent
SyncEventSessionNextStepEnded
SyncEventSessionNextStepEndedSyncEvent
SyncEventSessionNextStepFailed
SyncEventSessionNextStepFailedSyncEvent
SyncEventSessionNextStepStarted
SyncEventSessionNextStepStartedSyncEvent
SyncEventSessionNextSynthetic
SyncEventSessionNextSyntheticSyncEvent
SyncEventSessionNextTextEnded
SyncEventSessionNextTextEndedSyncEvent
SyncEventSessionNextTextStarted
SyncEventSessionNextTextStartedSyncEvent
SyncEventSessionNextToolCalled
SyncEventSessionNextToolCalledSyncEvent
SyncEventSessionNextToolFailed
SyncEventSessionNextToolFailedSyncEvent
SyncEventSessionNextToolInputEnded
SyncEventSessionNextToolInputEndedSyncEvent
SyncEventSessionNextToolInputStarted
SyncEventSessionNextToolInputStartedSyncEvent
SyncEventSessionNextToolProgress
SyncEventSessionNextToolProgressSyncEvent
SyncEventSessionNextToolSuccess
SyncEventSessionNextToolSuccessSyncEvent
SyncEventSessionUpdated
SyncEventSessionUpdatedSyncEvent
TextPart
TextPartInput
TextPartInputTime
Todo
TodoUpdated
TodoUpdatedData
ToolFileContent
ToolListItem
ToolPart
ToolStateCompleted
ToolStateCompletedTime
ToolStateError
ToolStateErrorTime
ToolStatePending
ToolStateRunning
ToolStateRunningTime
ToolTextContent
TuiCommandExecute
TuiCommandExecuteData
TuiPromptAppend
TuiPromptAppendData
TuiSessionSelect
TuiSessionSelectData
TuiToastShow
TuiToastShowData
UnauthorizedError
UnknownError
UnknownError1
UnknownErrorData
UserMessage
UserMessageModel
UserMessageSummary
UserMessageTime
V2EventStream
VcsApplyError
VcsApplyErrorData
VcsBranchUpdated
VcsBranchUpdatedData
VcsFileDiff
VcsFileStatus
VcsInfo
WellKnownAuth
Workspace
WorkspaceCreateError
WorkspaceEventConnectionStatus
WorkspaceFailed
WorkspaceReady
WorkspaceReadyData
WorkspaceStatus
WorkspaceStatusData
WorkspaceWarpError
Worktree
WorktreeCreateInput
WorktreeError
WorktreeFailed
WorktreeFailedData
WorktreeReady
WorktreeReadyData
WorktreeRemoveInput
WorktreeResetInput

Enums§

AgentColor
AgentConfigColor
Hex color code (e.g., #FF5733) or theme color (e.g., primary)
Auth
ConfigAutoupdate
Automatically update to the latest version. Set to true to auto-update, false to disable, or ‘notify’ to show update notifications Untagged union: serde tries each variant in the order below.
ConfigFormatter
Enable or configure formatters. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides. Untagged union: serde tries each variant in the order below.
ConfigLsp
Enable or configure LSP servers. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides. Untagged union: serde tries each variant in the order below.
ConfigLspVariant1Value
Untagged union: serde tries each variant in the order below.
ConfigMcpValue
Untagged union: serde tries each variant in the order below.
ConfigPluginItem
Untagged union: serde tries each variant in the order below.
ConfigReferencesValue
Untagged union: serde tries each variant in the order below.
ConnectionInfo
CredentialValue
Event
FilePartSource
GlobalEventPayload
Untagged union: serde tries each variant in the order below.
IntegrationAttemptStatus
IntegrationMethod
IntegrationOAuthMethodPromptsItem
LLMToolContent
LayoutConfig
@deprecated Always uses stretch layout.
LogLevel
Log level
MCPStatus
McpRemoteConfigOauth
OAuth authentication configuration for the MCP server. Set to false to disable OAuth auto-detection. Untagged union: serde tries each variant in the order below.
Message
ModelApi
ModelCapabilities2Interleaved
Untagged union: serde tries each variant in the order below.
OutputFormat
OutputFormat1
Part
PermissionAction
PermissionActionConfig
PermissionConfig
Untagged union: serde tries each variant in the order below.
PermissionReplyResponse
Decision sent when replying to a permission request (POST /session/{sessionID}/permissions/{permissionID}). The wire schema pins this to once / always / reject; the Unknown fallback preserves forward compatibility with newer server values.
PermissionRuleConfig
Untagged union: serde tries each variant in the order below.
PermissionV2Effect
PermissionV2Reply
PolicyEffect
ProjectVcs
PromptAsyncParamsPartsItem
ProviderApi
ProviderAuthMethodPromptsItem
ProviderConfigModelsValueInterleaved
Untagged union: serde tries each variant in the order below.
ProviderConfigOptionsHeaderTimeout
Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout. Untagged union: serde tries each variant in the order below.
ProviderConfigOptionsTimeout
Timeout in milliseconds for full requests to this provider. Set to false to disable timeout. Untagged union: serde tries each variant in the order below.
ReferenceSource
SessionDurableEvent
SessionErrorDataError
SessionMessage
SessionMessageAssistantContentItem
SessionMessageAssistantToolState
SessionStatus
SkillV2Source
ToolState
TuiCommandExecuteDataCommand
V2Event
WorkspaceTimeUsed
Untagged union: serde tries each variant in the order below.

Type Aliases§

PermissionRuleset
PermissionV2Ruleset
ProjectDirectories
QuestionAnswer
QuestionV2Answer
ToolIDs
ToolList