mirror of
https://github.com/aljazceru/opencode.git
synced 2025-12-18 16:34:18 +01:00
This release has a bunch of minor breaking changes if you are using opencode plugins or sdk 1. storage events have been removed (we might bring this back but had some issues) 2. concept of `app` is gone - there is a new concept called `project` and endpoints to list projects and get the current project 3. plugin receives `directory` which is cwd and `worktree` which is where the root of the project is if it's a git repo 4. the session.chat function has been renamed to session.prompt in sdk. it no longer requires model to be passed in (model is now an object) 5. every endpoint takes an optional `directory` parameter to operate as though opencode is running in that directory
36 KiB
36 KiB
Shared Response Types
Event
Response Types:
Methods:
client.Event.List(ctx context.Context, query opencode.EventListParams) (opencode.EventListResponse, error)
Path
Response Types:
Methods:
App
Response Types:
Methods:
client.App.Log(ctx context.Context, params opencode.AppLogParams) (bool, error)client.App.Providers(ctx context.Context, query opencode.AppProvidersParams) (opencode.AppProvidersResponse, error)
Agent
Response Types:
Methods:
Find
Response Types:
Methods:
client.Find.Files(ctx context.Context, query opencode.FindFilesParams) ([]string, error)client.Find.Symbols(ctx context.Context, query opencode.FindSymbolsParams) ([]opencode.Symbol, error)client.Find.Text(ctx context.Context, query opencode.FindTextParams) ([]opencode.FindTextResponse, error)
File
Response Types:
Methods:
client.File.List(ctx context.Context, query opencode.FileListParams) ([]opencode.FileNode, error)client.File.Read(ctx context.Context, query opencode.FileReadParams) (opencode.FileReadResponse, error)client.File.Status(ctx context.Context, query opencode.FileStatusParams) ([]opencode.File, error)
Config
Response Types:
Methods:
Command
Response Types:
Methods:
client.Command.List(ctx context.Context, query opencode.CommandListParams) ([]opencode.Command, error)
Project
Response Types:
Methods:
client.Project.List(ctx context.Context, query opencode.ProjectListParams) ([]opencode.Project, error)client.Project.Current(ctx context.Context, query opencode.ProjectCurrentParams) (opencode.Project, error)
Session
Params Types:
- opencode.AgentPartInputParam
- opencode.FilePartInputParam
- opencode.FilePartSourceUnionParam
- opencode.FilePartSourceTextParam
- opencode.FileSourceParam
- opencode.SymbolSourceParam
- opencode.TextPartInputParam
Response Types:
- opencode.AgentPart
- opencode.AssistantMessage
- opencode.FilePart
- opencode.FilePartSource
- opencode.FilePartSourceText
- opencode.FileSource
- opencode.Message
- opencode.Part
- opencode.ReasoningPart
- opencode.Session
- opencode.SnapshotPart
- opencode.StepFinishPart
- opencode.StepStartPart
- opencode.SymbolSource
- opencode.TextPart
- opencode.ToolPart
- opencode.ToolStateCompleted
- opencode.ToolStateError
- opencode.ToolStatePending
- opencode.ToolStateRunning
- opencode.UserMessage
- opencode.SessionCommandResponse
- opencode.SessionMessageResponse
- opencode.SessionMessagesResponse
- opencode.SessionPromptResponse
Methods:
client.Session.New(ctx context.Context, params opencode.SessionNewParams) (opencode.Session, error)client.Session.Update(ctx context.Context, id string, params opencode.SessionUpdateParams) (opencode.Session, error)client.Session.List(ctx context.Context, query opencode.SessionListParams) ([]opencode.Session, error)client.Session.Delete(ctx context.Context, id string, body opencode.SessionDeleteParams) (bool, error)client.Session.Abort(ctx context.Context, id string, body opencode.SessionAbortParams) (bool, error)client.Session.Children(ctx context.Context, id string, query opencode.SessionChildrenParams) ([]opencode.Session, error)client.Session.Command(ctx context.Context, id string, params opencode.SessionCommandParams) (opencode.SessionCommandResponse, error)client.Session.Get(ctx context.Context, id string, query opencode.SessionGetParams) (opencode.Session, error)client.Session.Init(ctx context.Context, id string, params opencode.SessionInitParams) (bool, error)client.Session.Message(ctx context.Context, id string, messageID string, query opencode.SessionMessageParams) (opencode.SessionMessageResponse, error)client.Session.Messages(ctx context.Context, id string, query opencode.SessionMessagesParams) ([]opencode.SessionMessagesResponse, error)client.Session.Prompt(ctx context.Context, id string, params opencode.SessionPromptParams) (opencode.SessionPromptResponse, error)client.Session.Revert(ctx context.Context, id string, params opencode.SessionRevertParams) (opencode.Session, error)client.Session.Share(ctx context.Context, id string, body opencode.SessionShareParams) (opencode.Session, error)client.Session.Shell(ctx context.Context, id string, params opencode.SessionShellParams) (opencode.AssistantMessage, error)client.Session.Summarize(ctx context.Context, id string, params opencode.SessionSummarizeParams) (bool, error)client.Session.Unrevert(ctx context.Context, id string, body opencode.SessionUnrevertParams) (opencode.Session, error)client.Session.Unshare(ctx context.Context, id string, body opencode.SessionUnshareParams) (opencode.Session, error)
Permissions
Response Types:
Methods:
client.Session.Permissions.Respond(ctx context.Context, id string, permissionID string, params opencode.SessionPermissionRespondParams) (bool, error)
Tui
Methods:
client.Tui.AppendPrompt(ctx context.Context, params opencode.TuiAppendPromptParams) (bool, error)client.Tui.ClearPrompt(ctx context.Context, body opencode.TuiClearPromptParams) (bool, error)client.Tui.ExecuteCommand(ctx context.Context, params opencode.TuiExecuteCommandParams) (bool, error)client.Tui.OpenHelp(ctx context.Context, body opencode.TuiOpenHelpParams) (bool, error)client.Tui.OpenModels(ctx context.Context, body opencode.TuiOpenModelsParams) (bool, error)client.Tui.OpenSessions(ctx context.Context, body opencode.TuiOpenSessionsParams) (bool, error)client.Tui.OpenThemes(ctx context.Context, body opencode.TuiOpenThemesParams) (bool, error)client.Tui.ShowToast(ctx context.Context, params opencode.TuiShowToastParams) (bool, error)client.Tui.SubmitPrompt(ctx context.Context, body opencode.TuiSubmitPromptParams) (bool, error)