Index

Modules: opencode, opencode/commands, opencode/config, opencode/control, opencode/controlplane, opencode/event, opencode/events, opencode/experimental, opencode/file, opencode/filesystem, opencode/global, opencode/instance, opencode/integrations, opencode/mcp, opencode/messages, opencode/models, opencode/opencode_httpapi, opencode/permission, opencode/permissions, opencode/private/metaclient, opencode/private/renames, opencode/private/types, opencode/project, opencode/projectcopy, opencode/provider, opencode/providers, opencode/pty, opencode/question, opencode/reference, opencode/session, opencode/session_questions, opencode/sessions, opencode/skills, opencode/sync, opencode/tui, opencode/workspace.

API symbols

`$`:
Agent:
AgentColor:
AgentConfig:
AgentPart:
AgentPartInput:
AgentV2Info:
allow:
always:
ApiAuth:
APIError:
ask:
AssistantMessage:
AttachmentConfig:
Auth:
auto:
BadRequestError:
CatalogUpdated:
Command:
CommandExecuted:
CommandV2Info:
CompactionPart:
Config:
ConfigV2ExperimentalPolicy:
ConfigV2ReferenceGit:
ConfigV2ReferenceLocal:
ConflictError:
ConnectionCredentialInfo:
ConnectionEnvInfo:
ConnectionInfo:
ConsoleState:
ContentFilterError:
ContextOverflowError:
CredentialKey:
CredentialOAuth:
CredentialValue:
DEBUG:
deleteApiCredentialCredentialID:
deleteApiIntegrationAttemptAttemptID:
deleteApiPermissionSavedId:
deleteApiPtyPtyID:
deleteAuthProviderID:
deleteExperimentalProjectProjectIDCopy:
deleteExperimentalWorkspaceId:
deleteExperimentalWorktree:
deleteMcpNameAuth:
DeleteMcpNameAuthResponse:
deletePtyPtyID:
deleteSessionSessionID:
deleteSessionSessionIDMessageMessageID:
deleteSessionSessionIDMessageMessageIDPartPartID:
deleteSessionSessionIDShare:
deny:
dirsFalse:
dirsTrue:
EffectHttpApiErrorBadRequest:
EffectHttpApiErrorForbidden:
EffectHttpApiErrorInternalServerError:
ERROR:
Event:
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:
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:
FileDiff:
FileDirsOption:
FileEdited:
FileNode:
FilePart:
FilePartInput:
FilePartSource:
FilePartSourceText:
FileSource:
FileSystemEntry:
FilesystemTypeOption:
FileTypeOption:
FileWatcherUpdated:
ForbiddenError:
FormatterStatus:
getAgent:
getApiAgent:
GetApiAgentResponse:
getApiCommand:
GetApiCommandResponse:
getApiEvent:
getApiFsFind:
GetApiFsFindResponse:
getApiFsList:
GetApiFsListResponse:
getApiFsRead:
getApiHealth:
GetApiHealthResponse:
getApiIntegration:
getApiIntegrationAttemptAttemptID:
GetApiIntegrationAttemptAttemptIDResponse:
getApiIntegrationIntegrationID:
GetApiIntegrationIntegrationIDResponse:
GetApiIntegrationResponse:
getApiLocation:
getApiModel:
GetApiModelResponse:
getApiPermissionRequest:
GetApiPermissionRequestResponse:
getApiPermissionSaved:
GetApiPermissionSavedResponse:
getApiProvider:
getApiProviderProviderID:
GetApiProviderProviderIDResponse:
GetApiProviderResponse:
getApiPty:
getApiPtyPtyID:
getApiPtyPtyIDConnect:
GetApiPtyPtyIDResponse:
GetApiPtyResponse:
getApiQuestionRequest:
GetApiQuestionRequestResponse:
getApiReference:
GetApiReferenceResponse:
getApiSession:
getApiSessionActive:
GetApiSessionActiveResponse:
getApiSessionSessionID:
getApiSessionSessionIDContext:
GetApiSessionSessionIDContextResponse:
getApiSessionSessionIDEvent:
getApiSessionSessionIDHistory:
getApiSessionSessionIDMessage:
getApiSessionSessionIDMessageMessageID:
GetApiSessionSessionIDMessageMessageIDResponse:
getApiSessionSessionIDPermission:
getApiSessionSessionIDPermissionRequestID:
GetApiSessionSessionIDPermissionRequestIDResponse:
GetApiSessionSessionIDPermissionResponse:
getApiSessionSessionIDQuestion:
GetApiSessionSessionIDQuestionResponse:
GetApiSessionSessionIDResponse:
getApiSkill:
GetApiSkillResponse:
getCommand:
getConfig:
getConfigProviders:
GetConfigProvidersResponse:
getEvent:
getExperimentalCapabilities:
getExperimentalConsole:
getExperimentalConsoleOrgs:
GetExperimentalConsoleOrgsResponse:
getExperimentalResource:
getExperimentalSession:
getExperimentalTool:
getExperimentalToolIds:
getExperimentalWorkspace:
getExperimentalWorkspaceAdapter:
getExperimentalWorkspaceStatus:
getExperimentalWorktree:
getFile:
getFileContent:
getFileStatus:
getFind:
getFindFile:
getFindSymbol:
getFormatter:
getGlobalConfig:
getGlobalEvent:
getGlobalHealth:
GetGlobalHealthResponse:
getLsp:
getMcp:
getPath:
getPermission:
getProject:
getProjectCurrent:
getProjectProjectIDDirectories:
getProvider:
getProviderAuth:
GetProviderResponse:
getPty:
getPtyPtyID:
getPtyPtyIDConnect:
getPtyShells:
getQuestion:
getSession:
getSessionSessionID:
getSessionSessionIDChildren:
getSessionSessionIDDiff:
getSessionSessionIDMessage:
getSessionSessionIDMessageMessageID:
GetSessionSessionIDMessageMessageIDResponse:
getSessionSessionIDTodo:
getSessionStatus:
getSkill:
getTuiControlNext:
GetTuiControlNextResponse:
getVcs:
getVcsDiff:
getVcsDiffRaw:
getVcsStatus:
git:
GlobalDisposed:
GlobalEvent:
GlobalSession:
httpDelete:
httpGet:
httpPatch:
httpPost:
httpPut:
ImageAttachmentConfig:
INFO:
initOpencodeClient:
InstallationUpdateAvailable:
InstallationUpdated:
InstanceModeOption:
IntegrationAttempt:
IntegrationAttemptStatus:
IntegrationConnectionUpdated:
IntegrationEnvMethod:
IntegrationInfo:
IntegrationInputs:
IntegrationKeyMethod:
IntegrationMethod:
IntegrationOAuthMethod:
IntegrationRef:
IntegrationSelectPrompt:
IntegrationTextPrompt:
IntegrationUpdated:
IntegrationWhen:
InvalidCursorError:
InvalidRequestError:
JSONSchema:
LayoutConfig:
LLMProviderMetadata:
LLMToolContent:
LocationInfo:
LocationRef:
LogLevel:
LSPStatus:
LspUpdated:
McpBrowserOpenFailed:
McpLocalConfig:
McpOAuthConfig:
McpRemoteConfig:
McpResource:
McpServerNotFoundError:
MCPStatus:
MCPStatusConnected:
MCPStatusDisabled:
MCPStatusFailed:
MCPStatusNeedsAuth:
MCPStatusNeedsClientRegistration:
McpToolsChanged:
McpUnsupportedOAuthError:
Message:
MessageAbortedError:
MessageNotFoundError:
MessageOrderOption:
MessageOutputLengthError:
MessagePartDelta:
MessagePartRemoved:
MessagePartUpdated:
MessageRemoved:
MessageUpdated:
modeBranch:
modeGit:
Model:
ModelApi:
ModelCapabilities:
ModelCost:
ModelRef:
ModelsDevRefreshed:
ModelV2Info:
MoveSessionDestination:
MoveSessionError:
NotFoundError:
OAuth:
once:
OpencodeClient:
OpencodeClientError:
orderAsc:
orderDesc:
OutputFormat:
OutputFormat1:
OutputFormatJsonSchema:
OutputFormatText:
Part:
patchApiCredentialCredentialID:
patchConfig:
patchGlobalConfig:
PatchPart:
patchProjectProjectID:
patchSessionSessionID:
patchSessionSessionIDMessageMessageIDPartPartID:
Path:
PermissionAction:
PermissionActionConfig:
PermissionAsked:
PermissionConfig:
PermissionNotFoundError:
PermissionObjectConfig:
PermissionReplied:
PermissionRequest:
PermissionRule:
PermissionRuleConfig:
PermissionRuleset:
PermissionSavedInfo:
PermissionV2Asked:
PermissionV2Effect:
PermissionV2Replied:
PermissionV2Reply:
PermissionV2Request:
PermissionV2Rule:
PermissionV2Ruleset:
PermissionV2Source:
PluginAdded:
PolicyEffect:
postApiIntegrationAttemptAttemptIDComplete:
postApiIntegrationIntegrationIDConnectKey:
postApiIntegrationIntegrationIDConnectOauth:
PostApiIntegrationIntegrationIDConnectOauthResponse:
postApiPty:
postApiPtyPtyIDConnectToken:
PostApiPtyPtyIDConnectTokenResponse:
PostApiPtyResponse:
postApiSession:
PostApiSessionResponse:
postApiSessionSessionIDAgent:
postApiSessionSessionIDCompact:
postApiSessionSessionIDInterrupt:
postApiSessionSessionIDModel:
postApiSessionSessionIDPermission:
postApiSessionSessionIDPermissionRequestIDReply:
PostApiSessionSessionIDPermissionResponse:
postApiSessionSessionIDPrompt:
PostApiSessionSessionIDPromptResponse:
postApiSessionSessionIDQuestionRequestIDReject:
postApiSessionSessionIDQuestionRequestIDReply:
postApiSessionSessionIDRevertClear:
postApiSessionSessionIDRevertCommit:
postApiSessionSessionIDRevertStage:
PostApiSessionSessionIDRevertStageResponse:
postApiSessionSessionIDWait:
postExperimentalConsoleSwitch:
postExperimentalControlPlaneMoveSession:
postExperimentalProjectProjectIDCopy:
postExperimentalProjectProjectIDCopyGenerateName:
PostExperimentalProjectProjectIDCopyGenerateNameResponse:
postExperimentalProjectProjectIDCopyRefresh:
postExperimentalSessionSessionIDBackground:
postExperimentalWorkspace:
postExperimentalWorkspaceSyncList:
postExperimentalWorkspaceWarp:
postExperimentalWorktree:
postExperimentalWorktreeReset:
postGlobalDispose:
postGlobalUpgrade:
postInstanceDispose:
postLog:
postMcp:
postMcpNameAuth:
postMcpNameAuthAuthenticate:
postMcpNameAuthCallback:
PostMcpNameAuthResponse:
postMcpNameConnect:
postMcpNameDisconnect:
postPermissionRequestIDReply:
postProjectGitInit:
postProviderProviderIDOauthAuthorize:
postProviderProviderIDOauthCallback:
postPty:
postPtyPtyIDConnectToken:
postQuestionRequestIDReject:
postQuestionRequestIDReply:
postSession:
postSessionSessionIDAbort:
postSessionSessionIDCommand:
PostSessionSessionIDCommandResponse:
postSessionSessionIDFork:
postSessionSessionIDInit:
postSessionSessionIDMessage:
PostSessionSessionIDMessageResponse:
postSessionSessionIDPermissionsPermissionID:
postSessionSessionIDPromptAsync:
postSessionSessionIDRevert:
postSessionSessionIDShare:
postSessionSessionIDShell:
PostSessionSessionIDShellResponse:
postSessionSessionIDSummarize:
postSessionSessionIDUnrevert:
postSyncHistory:
postSyncReplay:
PostSyncReplayResponse:
postSyncStart:
postSyncSteal:
PostSyncStealResponse:
postTuiAppendPrompt:
postTuiClearPrompt:
postTuiControlResponse:
postTuiExecuteCommand:
postTuiOpenHelp:
postTuiOpenModels:
postTuiOpenSessions:
postTuiOpenThemes:
postTuiPublish:
postTuiSelectSession:
postTuiShowToast:
postTuiSubmitPrompt:
postVcsApply:
PostVcsApplyResponse:
Project:
ProjectCommands:
ProjectCopyCopy:
ProjectCopyError:
ProjectDirectories:
ProjectDirectoriesUpdated:
ProjectIcon:
ProjectNotFoundError:
ProjectSummary:
ProjectTime:
ProjectUpdated:
ProjectVcs:
Prompt:
PromptAgentAttachment:
PromptFileAttachment:
PromptInput:
PromptInputFileAttachment:
PromptSource:
Provider:
ProviderAISDK:
ProviderApi:
ProviderAuthAuthorization:
ProviderAuthError:
ProviderAuthError1:
ProviderAuthMethod:
ProviderConfig:
ProviderNative:
ProviderNotFoundError:
ProviderRequest:
ProviderV2Info:
Pty:
PtyCreated:
PtyDeleted:
PtyExited:
PtyForbiddenError:
PtyNotFoundError:
PtyTicketConnectToken:
PtyUpdated:
putApiPtyPtyID:
PutApiPtyPtyIDResponse:
putAuthProviderID:
putPtyPtyID:
QueryTable:
QuestionAnswer:
QuestionAsked:
QuestionInfo:
QuestionNotFoundError:
QuestionOption:
QuestionRejected:
QuestionRejected2:
QuestionReplied:
QuestionReplied2:
QuestionRequest:
QuestionTool:
QuestionV2Answer:
QuestionV2Asked:
QuestionV2Info:
QuestionV2Option:
QuestionV2Rejected:
QuestionV2Replied:
QuestionV2Reply:
QuestionV2Request:
QuestionV2Tool:
Range:
ReasoningPart:
ReferenceGitSource:
ReferenceInfo:
ReferenceLocalSource:
ReferenceSource:
ReferenceUpdated:
reject:
renameHook:
ResourceSource:
RetryPart:
RevertState:
scopeProject:
ServerConfig:
ServerConnected:
ServiceUnavailableError:
Session:
SessionActive:
SessionBusyError:
SessionCompacted:
SessionCreated:
SessionDeleted:
SessionDiff:
SessionDurableEvent:
SessionDurableEventStream:
SessionError:
SessionErrorUnknown:
SessionHistory:
SessionIdle:
SessionInputAdmitted:
SessionMessage:
SessionMessageAgentSwitched:
SessionMessageAssistant:
SessionMessageAssistantReasoning:
SessionMessageAssistantText:
SessionMessageAssistantTool:
SessionMessageCompaction:
SessionMessageModelSwitched:
SessionMessageShell:
SessionMessagesResponse:
SessionMessageSynthetic:
SessionMessageSystem:
SessionMessageToolStateCompleted:
SessionMessageToolStateError:
SessionMessageToolStatePending:
SessionMessageToolStateRunning:
SessionMessageUser:
SessionNextAgentSwitched:
SessionNextCompactionDelta:
SessionNextCompactionEnded:
SessionNextCompactionStarted:
SessionNextContextUpdated:
SessionNextModelSwitched:
SessionNextMoved:
SessionNextPromptAdmitted:
SessionNextPrompted:
SessionNextReasoningDelta:
SessionNextReasoningEnded:
SessionNextReasoningStarted:
SessionNextRetried:
SessionNextRetryError:
SessionNextRevertCleared:
SessionNextRevertCommitted:
SessionNextRevertStaged:
SessionNextShellEnded:
SessionNextShellStarted:
SessionNextStepEnded:
SessionNextStepFailed:
SessionNextStepStarted:
SessionNextSynthetic:
SessionNextTextDelta:
SessionNextTextEnded:
SessionNextTextStarted:
SessionNextToolCalled:
SessionNextToolFailed:
SessionNextToolInputDelta:
SessionNextToolInputEnded:
SessionNextToolInputStarted:
SessionNextToolProgress:
SessionNextToolSuccess:
SessionNotFoundError:
SessionOrderOption:
SessionScopeOption:
SessionsResponse:
SessionStatus:
SessionStatus2:
SessionUpdated:
SessionV2Info:
SkillV2DirectorySource:
SkillV2EmbeddedSource:
SkillV2Info:
SkillV2Source:
SkillV2UrlSource:
SnapshotFileDiff:
SnapshotPart:
StepFinishPart:
StepStartPart:
stretch:
StructuredOutputError:
SubtaskPart:
SubtaskPartInput:
Symbol:
SymbolSource:
SyncEventMessagePartRemoved:
SyncEventMessagePartUpdated:
SyncEventMessageRemoved:
SyncEventMessageUpdated:
SyncEventSessionCreated:
SyncEventSessionDeleted:
SyncEventSessionNextAgentSwitched:
SyncEventSessionNextCompactionEnded:
SyncEventSessionNextCompactionStarted:
SyncEventSessionNextContextUpdated:
SyncEventSessionNextModelSwitched:
SyncEventSessionNextMoved:
SyncEventSessionNextPromptAdmitted:
SyncEventSessionNextPrompted:
SyncEventSessionNextReasoningEnded:
SyncEventSessionNextReasoningStarted:
SyncEventSessionNextRetried:
SyncEventSessionNextRevertCleared:
SyncEventSessionNextRevertCommitted:
SyncEventSessionNextRevertStaged:
SyncEventSessionNextShellEnded:
SyncEventSessionNextShellStarted:
SyncEventSessionNextStepEnded:
SyncEventSessionNextStepFailed:
SyncEventSessionNextStepStarted:
SyncEventSessionNextSynthetic:
SyncEventSessionNextTextEnded:
SyncEventSessionNextTextStarted:
SyncEventSessionNextToolCalled:
SyncEventSessionNextToolFailed:
SyncEventSessionNextToolInputEnded:
SyncEventSessionNextToolInputStarted:
SyncEventSessionNextToolProgress:
SyncEventSessionNextToolSuccess:
SyncEventSessionUpdated:
TextPart:
TextPartInput:
Todo:
TodoUpdated:
ToolFileContent:
ToolIDs:
ToolList:
ToolListItem:
ToolPart:
ToolState:
ToolStateCompleted:
ToolStateError:
ToolStatePending:
ToolStateRunning:
ToolTextContent:
TuiCommandExecute:
TuiPromptAppend:
TuiSessionSelect:
TuiToastShow:
typeDirectory:
typeFile:
UnauthorizedError:
UnknownError:
UnknownError1:
UserMessage:
V2Event:
V2EventStream:
VcsApplyError:
VcsBranchUpdated:
VcsFileDiff:
VcsFileStatus:
VcsInfo:
WARN:
WellKnownAuth:
Workspace:
WorkspaceCreateError:
WorkspaceEventConnectionStatus:
WorkspaceFailed:
WorkspaceReady:
WorkspaceStatus:
WorkspaceWarpError:
Worktree:
WorktreeCreateInput:
WorktreeError:
WorktreeFailed:
WorktreeReady:
WorktreeRemoveInput:
WorktreeResetInput: