Documentation
¶
Overview ¶
Package codexsdk provides a concrete Client for interacting with a Codex app-server. New returns the only connected form, *Client. The safe, inert zero value closes successfully and returns ErrClientClosed from operations. Generated facade accessors return exported concrete opaque values. Consumers should define narrow interfaces around only the operations they use.
Client owns process transport, client lifecycle, generated protocol facades, exact thread/turn composition, and typed callback delivery. Exact run notifications retain ingestion order across stream attachment: pending notifications are accepted before later live notifications for the same run. A successfully decoded lifecycle response remains observable as exact partial evidence when a required thread or turn identity is missing. ErrMissingThreadID and ErrMissingTurnID fail closed before the next lifecycle stage or live run registration; these malformed responses do not close the Client. Exact run results retain complete immutable notification history independent of observation. Wait observes completion without consuming notifications; Next advances a cursor over the same ordered history. The configurable global notification-handler queue remains bounded, and its overflow closes the client with ErrNotificationBackpressure. Exact run history follows generated-schema identity: turn-scoped facts attach only to the matching turn; thread-scoped facts attach to every run currently active or attaching for that thread and are not retained for a later run; client/global facts never enter per-run evidence. Every validated generated notification is still enqueued for the global handler, in ingestion order, after its justified per-run append completes. A terminal exact notification cannot complete its affected stream until that notification's global handler invocation has returned and any handler failure is published as the client first cause. If shutdown, failure, or bounded backpressure rejects handler work before queue ownership transfers, its dispatch fence is released as discarded without removing already accepted exact-run evidence. Exact server-request failures likewise close callback admission and publish their typed first cause to active runs before the fail-closed protocol response can prompt a terminal notification; transport teardown starts only after that response is written. Client shutdown atomically closes callback admission and joins callbacks accepted before that boundary before releasing transport resources.
It does not provide provider-neutral LLM abstractions, business validation, workflow policy, or application safety profiles.
Index ¶
- Variables
- type Accounts
- func (f Accounts) LoginCancel(ctx context.Context, params protocolv2.CancelLoginAccountParams) (protocolv2.CancelLoginAccountResponse, error)
- func (f Accounts) LoginStart(ctx context.Context, params protocolv2.LoginAccountParams) (protocolv2.LoginAccountResponse, error)
- func (f Accounts) Logout(ctx context.Context) (protocolv2.LogoutAccountResponse, error)
- func (f Accounts) RateLimitResetCreditConsume(ctx context.Context, ...) (protocolv2.ConsumeAccountRateLimitResetCreditResponse, error)
- func (f Accounts) RateLimitsRead(ctx context.Context) (protocolv2.GetAccountRateLimitsResponse, error)
- func (f Accounts) Read(ctx context.Context, params protocolv2.GetAccountParams) (protocolv2.GetAccountResponse, error)
- func (f Accounts) SendAddCreditsNudgeEmail(ctx context.Context, params protocolv2.SendAddCreditsNudgeEmailParams) (protocolv2.SendAddCreditsNudgeEmailResponse, error)
- func (f Accounts) WorkspaceMessagesRead(ctx context.Context) (protocolv2.GetWorkspaceMessagesResponse, error)
- type Apps
- type Client
- func (c *Client) Accounts() Accounts
- func (c *Client) Apps() Apps
- func (c *Client) Close() error
- func (c *Client) CollaborationModes() CollaborationModes
- func (c *Client) Commands() Commands
- func (c *Client) Config() Config
- func (c *Client) ConfigRequirements() ConfigRequirements
- func (c *Client) Environments() Environments
- func (c *Client) ExperimentalFeatures() ExperimentalFeatures
- func (c *Client) ExternalAgentConfigs() ExternalAgentConfigs
- func (c *Client) FS() FS
- func (c *Client) Feedback() Feedback
- func (c *Client) FuzzyFileSearch() FuzzyFileSearch
- func (c *Client) Hooks() Hooks
- func (c *Client) MCPServerStatus() MCPServerStatus
- func (c *Client) MCPServers() MCPServers
- func (c *Client) Marketplace() Marketplace
- func (c *Client) Memory() Memory
- func (c *Client) Mock() Mock
- func (c *Client) ModelProviders() ModelProviders
- func (c *Client) Models() Models
- func (c *Client) Plugins() Plugins
- func (c *Client) Processes() Processes
- func (c *Client) RemoteControl() RemoteControl
- func (c *Client) Reviews() Reviews
- func (c *Client) Skills() Skills
- func (c *Client) ThreadRunner() ThreadRunner
- func (c *Client) Threads() Threads
- func (c *Client) Turns() Turns
- func (c *Client) WindowsSandbox() WindowsSandbox
- type ClientOptions
- type CollaborationModes
- type Commands
- func (f Commands) Exec(ctx context.Context, params protocolv2.CommandExecParams) (protocolv2.CommandExecResponse, error)
- func (f Commands) ExecResize(ctx context.Context, params protocolv2.CommandExecResizeParams) (protocolv2.CommandExecResizeResponse, error)
- func (f Commands) ExecTerminate(ctx context.Context, params protocolv2.CommandExecTerminateParams) (protocolv2.CommandExecTerminateResponse, error)
- func (f Commands) ExecWrite(ctx context.Context, params protocolv2.CommandExecWriteParams) (protocolv2.CommandExecWriteResponse, error)
- type Config
- func (f Config) BatchWrite(ctx context.Context, params protocolv2.ConfigBatchWriteParams) (protocolv2.ConfigWriteResponse, error)
- func (f Config) MCPServerReload(ctx context.Context) (protocolv2.McpServerRefreshResponse, error)
- func (f Config) Read(ctx context.Context, params protocolv2.ConfigReadParams) (protocolv2.ConfigReadResponse, error)
- func (f Config) ValueWrite(ctx context.Context, params protocolv2.ConfigValueWriteParams) (protocolv2.ConfigWriteResponse, error)
- type ConfigRequirements
- type DiagnosticRef
- type Environments
- type ExactServerRequestError
- type ExperimentalFeatures
- func (f ExperimentalFeatures) EnablementSet(ctx context.Context, params protocolv2.ExperimentalFeatureEnablementSetParams) (protocolv2.ExperimentalFeatureEnablementSetResponse, error)
- func (f ExperimentalFeatures) List(ctx context.Context, params protocolv2.ExperimentalFeatureListParams) (protocolv2.ExperimentalFeatureListResponse, error)
- type ExternalAgentConfigs
- func (f ExternalAgentConfigs) Detect(ctx context.Context, params protocolv2.ExternalAgentConfigDetectParams) (protocolv2.ExternalAgentConfigDetectResponse, error)
- func (f ExternalAgentConfigs) Import(ctx context.Context, params protocolv2.ExternalAgentConfigImportParams) (protocolv2.ExternalAgentConfigImportResponse, error)
- func (f ExternalAgentConfigs) ImportReadHistories(ctx context.Context) (protocolv2.ExternalAgentConfigImportHistoriesReadResponse, error)
- type FS
- func (f FS) Copy(ctx context.Context, params protocolv2.FsCopyParams) (protocolv2.FsCopyResponse, error)
- func (f FS) CreateDirectory(ctx context.Context, params protocolv2.FsCreateDirectoryParams) (protocolv2.FsCreateDirectoryResponse, error)
- func (f FS) GetMetadata(ctx context.Context, params protocolv2.FsGetMetadataParams) (protocolv2.FsGetMetadataResponse, error)
- func (f FS) ReadDirectory(ctx context.Context, params protocolv2.FsReadDirectoryParams) (protocolv2.FsReadDirectoryResponse, error)
- func (f FS) ReadFile(ctx context.Context, params protocolv2.FsReadFileParams) (protocolv2.FsReadFileResponse, error)
- func (f FS) Remove(ctx context.Context, params protocolv2.FsRemoveParams) (protocolv2.FsRemoveResponse, error)
- func (f FS) Unwatch(ctx context.Context, params protocolv2.FsUnwatchParams) (protocolv2.FsUnwatchResponse, error)
- func (f FS) Watch(ctx context.Context, params protocolv2.FsWatchParams) (protocolv2.FsWatchResponse, error)
- func (f FS) WriteFile(ctx context.Context, params protocolv2.FsWriteFileParams) (protocolv2.FsWriteFileResponse, error)
- type Feedback
- type FuzzyFileSearch
- func (f FuzzyFileSearch) Search(ctx context.Context, params protocolv2.FuzzyFileSearchParams) (protocolv2.FuzzyFileSearchResponse, error)
- func (f FuzzyFileSearch) SessionStart(ctx context.Context, params protocolv2.FuzzyFileSearchSessionStartParams) (protocolv2.FuzzyFileSearchSessionStartResponse, error)
- func (f FuzzyFileSearch) SessionStop(ctx context.Context, params protocolv2.FuzzyFileSearchSessionStopParams) (protocolv2.FuzzyFileSearchSessionStopResponse, error)
- func (f FuzzyFileSearch) SessionUpdate(ctx context.Context, params protocolv2.FuzzyFileSearchSessionUpdateParams) (protocolv2.FuzzyFileSearchSessionUpdateResponse, error)
- type Hooks
- type InputStats
- type MCPServerStatus
- type MCPServers
- func (f MCPServers) OAuthLogin(ctx context.Context, params protocolv2.McpServerOauthLoginParams) (protocolv2.McpServerOauthLoginResponse, error)
- func (f MCPServers) ResourceRead(ctx context.Context, params protocolv2.McpResourceReadParams) (protocolv2.McpResourceReadResponse, error)
- func (f MCPServers) ToolCall(ctx context.Context, params protocolv2.McpServerToolCallParams) (protocolv2.McpServerToolCallResponse, error)
- type Marketplace
- func (f Marketplace) Add(ctx context.Context, params protocolv2.MarketplaceAddParams) (protocolv2.MarketplaceAddResponse, error)
- func (f Marketplace) Remove(ctx context.Context, params protocolv2.MarketplaceRemoveParams) (protocolv2.MarketplaceRemoveResponse, error)
- func (f Marketplace) Upgrade(ctx context.Context, params protocolv2.MarketplaceUpgradeParams) (protocolv2.MarketplaceUpgradeResponse, error)
- type Memory
- type Mock
- type ModelProviders
- type Models
- type Plugins
- func (f Plugins) Install(ctx context.Context, params protocolv2.PluginInstallParams) (protocolv2.PluginInstallResponse, error)
- func (f Plugins) Installed(ctx context.Context, params protocolv2.PluginInstalledParams) (protocolv2.PluginInstalledResponse, error)
- func (f Plugins) List(ctx context.Context, params protocolv2.PluginListParams) (protocolv2.PluginListResponse, error)
- func (f Plugins) Read(ctx context.Context, params protocolv2.PluginReadParams) (protocolv2.PluginReadResponse, error)
- func (f Plugins) ShareCheckout(ctx context.Context, params protocolv2.PluginShareCheckoutParams) (protocolv2.PluginShareCheckoutResponse, error)
- func (f Plugins) ShareDelete(ctx context.Context, params protocolv2.PluginShareDeleteParams) (protocolv2.PluginShareDeleteResponse, error)
- func (f Plugins) ShareList(ctx context.Context, params protocolv2.PluginShareListParams) (protocolv2.PluginShareListResponse, error)
- func (f Plugins) ShareSave(ctx context.Context, params protocolv2.PluginShareSaveParams) (protocolv2.PluginShareSaveResponse, error)
- func (f Plugins) ShareUpdateTargets(ctx context.Context, params protocolv2.PluginShareUpdateTargetsParams) (protocolv2.PluginShareUpdateTargetsResponse, error)
- func (f Plugins) SkillRead(ctx context.Context, params protocolv2.PluginSkillReadParams) (protocolv2.PluginSkillReadResponse, error)
- func (f Plugins) Uninstall(ctx context.Context, params protocolv2.PluginUninstallParams) (protocolv2.PluginUninstallResponse, error)
- type Processes
- func (f Processes) Kill(ctx context.Context, params protocolv2.ProcessKillParams) (protocolv2.ProcessKillResponse, error)
- func (f Processes) ResizePTY(ctx context.Context, params protocolv2.ProcessResizePtyParams) (protocolv2.ProcessResizePtyResponse, error)
- func (f Processes) Spawn(ctx context.Context, params protocolv2.ProcessSpawnParams) (protocolv2.ProcessSpawnResponse, error)
- func (f Processes) WriteStdin(ctx context.Context, params protocolv2.ProcessWriteStdinParams) (protocolv2.ProcessWriteStdinResponse, error)
- type ProtocolError
- type RemoteControl
- func (f RemoteControl) ClientRevoke(ctx context.Context, params protocolv2.RemoteControlClientsRevokeParams) (protocolv2.RemoteControlClientsRevokeResponse, error)
- func (f RemoteControl) Disable(ctx context.Context) (protocolv2.RemoteControlDisableResponse, error)
- func (f RemoteControl) Enable(ctx context.Context) (protocolv2.RemoteControlEnableResponse, error)
- func (f RemoteControl) PairingStart(ctx context.Context, params protocolv2.RemoteControlPairingStartParams) (protocolv2.RemoteControlPairingStartResponse, error)
- func (f RemoteControl) PairingStatus(ctx context.Context, params protocolv2.RemoteControlPairingStatusParams) (protocolv2.RemoteControlPairingStatusResponse, error)
- func (f RemoteControl) StatusRead(ctx context.Context) (protocolv2.RemoteControlStatusReadResponse, error)
- type ResumeThreadRunRequest
- type ResumedThreadRun
- type Reviews
- type ServerNotificationHandler
- type ServerRequestHandler
- type ServerRequestResponse
- func ApplyPatchApprovalResponse(value protocolv2.ApplyPatchApprovalResponse) ServerRequestResponse
- func AttestationResponse(value protocolv2.AttestationGenerateResponse) ServerRequestResponse
- func ChatGPTAuthRefreshResponse(value protocolv2.ChatgptAuthTokensRefreshResponse) ServerRequestResponse
- func CommandExecutionApprovalResponse(value protocolv2.CommandExecutionRequestApprovalResponse) ServerRequestResponse
- func CurrentTimeResponse(value protocolv2.CurrentTimeReadResponse) ServerRequestResponse
- func DynamicToolResponse(value protocolv2.DynamicToolCallResponse) ServerRequestResponse
- func ExecCommandApprovalResponse(value protocolv2.ExecCommandApprovalResponse) ServerRequestResponse
- func FileChangeApprovalResponse(value protocolv2.FileChangeRequestApprovalResponse) ServerRequestResponse
- func MCPElicitationResponse(value protocolv2.McpServerElicitationRequestResponse) ServerRequestResponse
- func PermissionsApprovalResponse(value protocolv2.PermissionsRequestApprovalResponse) ServerRequestResponse
- func ToolUserInputResponse(value protocolv2.ToolRequestUserInputResponse) ServerRequestResponse
- type Skills
- func (f Skills) ConfigWrite(ctx context.Context, params protocolv2.SkillsConfigWriteParams) (protocolv2.SkillsConfigWriteResponse, error)
- func (f Skills) ExtraRootsSet(ctx context.Context, params protocolv2.SkillsExtraRootsSetParams) (protocolv2.SkillsExtraRootsSetResponse, error)
- func (f Skills) List(ctx context.Context, params protocolv2.SkillsListParams) (protocolv2.SkillsListResponse, error)
- type StartThreadRunRequest
- type StartedThreadRun
- type Stream
- type ThreadRunResult
- type ThreadRunner
- type Threads
- func (f Threads) ApproveGuardianDeniedAction(ctx context.Context, params protocolv2.ThreadApproveGuardianDeniedActionParams) (protocolv2.ThreadApproveGuardianDeniedActionResponse, error)
- func (f Threads) Archive(ctx context.Context, params protocolv2.ThreadArchiveParams) (protocolv2.ThreadArchiveResponse, error)
- func (f Threads) BackgroundTerminalsClean(ctx context.Context, params protocolv2.ThreadBackgroundTerminalsCleanParams) (protocolv2.ThreadBackgroundTerminalsCleanResponse, error)
- func (f Threads) BackgroundTerminalsTerminate(ctx context.Context, ...) (protocolv2.ThreadBackgroundTerminalsTerminateResponse, error)
- func (f Threads) CompactStart(ctx context.Context, params protocolv2.ThreadCompactStartParams) (protocolv2.ThreadCompactStartResponse, error)
- func (f Threads) DecrementElicitation(ctx context.Context, params protocolv2.ThreadDecrementElicitationParams) (protocolv2.ThreadDecrementElicitationResponse, error)
- func (f Threads) Delete(ctx context.Context, params protocolv2.ThreadDeleteParams) (protocolv2.ThreadDeleteResponse, error)
- func (f Threads) Fork(ctx context.Context, params protocolv2.ThreadForkParams) (protocolv2.ThreadForkResponse, error)
- func (f Threads) GoalClear(ctx context.Context, params protocolv2.ThreadGoalClearParams) (protocolv2.ThreadGoalClearResponse, error)
- func (f Threads) GoalGet(ctx context.Context, params protocolv2.ThreadGoalGetParams) (protocolv2.ThreadGoalGetResponse, error)
- func (f Threads) GoalSet(ctx context.Context, params protocolv2.ThreadGoalSetParams) (protocolv2.ThreadGoalSetResponse, error)
- func (f Threads) IncrementElicitation(ctx context.Context, params protocolv2.ThreadIncrementElicitationParams) (protocolv2.ThreadIncrementElicitationResponse, error)
- func (f Threads) InjectItems(ctx context.Context, params protocolv2.ThreadInjectItemsParams) (protocolv2.ThreadInjectItemsResponse, error)
- func (f Threads) ItemsList(ctx context.Context, params protocolv2.ThreadItemsListParams) (protocolv2.ThreadItemsListResponse, error)
- func (f Threads) List(ctx context.Context, params protocolv2.ThreadListParams) (protocolv2.ThreadListResponse, error)
- func (f Threads) LoadedList(ctx context.Context, params protocolv2.ThreadLoadedListParams) (protocolv2.ThreadLoadedListResponse, error)
- func (f Threads) MemoryModeSet(ctx context.Context, params protocolv2.ThreadMemoryModeSetParams) (protocolv2.ThreadMemoryModeSetResponse, error)
- func (f Threads) MetadataUpdate(ctx context.Context, params protocolv2.ThreadMetadataUpdateParams) (protocolv2.ThreadMetadataUpdateResponse, error)
- func (f Threads) NameSet(ctx context.Context, params protocolv2.ThreadSetNameParams) (protocolv2.ThreadSetNameResponse, error)
- func (f Threads) Read(ctx context.Context, params protocolv2.ThreadReadParams) (protocolv2.ThreadReadResponse, error)
- func (f Threads) RealtimeAppendAudio(ctx context.Context, params protocolv2.ThreadRealtimeAppendAudioParams) (protocolv2.ThreadRealtimeAppendAudioResponse, error)
- func (f Threads) RealtimeAppendSpeech(ctx context.Context, params protocolv2.ThreadRealtimeAppendSpeechParams) (protocolv2.ThreadRealtimeAppendSpeechResponse, error)
- func (f Threads) RealtimeAppendText(ctx context.Context, params protocolv2.ThreadRealtimeAppendTextParams) (protocolv2.ThreadRealtimeAppendTextResponse, error)
- func (f Threads) RealtimeListVoices(ctx context.Context, params protocolv2.ThreadRealtimeListVoicesParams) (protocolv2.ThreadRealtimeListVoicesResponse, error)
- func (f Threads) RealtimeStart(ctx context.Context, params protocolv2.ThreadRealtimeStartParams) (protocolv2.ThreadRealtimeStartResponse, error)
- func (f Threads) RealtimeStop(ctx context.Context, params protocolv2.ThreadRealtimeStopParams) (protocolv2.ThreadRealtimeStopResponse, error)
- func (f Threads) Resume(ctx context.Context, params protocolv2.ThreadResumeParams) (protocolv2.ThreadResumeResponse, error)
- func (f Threads) Rollback(ctx context.Context, params protocolv2.ThreadRollbackParams) (protocolv2.ThreadRollbackResponse, error)
- func (f Threads) SettingsUpdate(ctx context.Context, params protocolv2.ThreadSettingsUpdateParams) (protocolv2.ThreadSettingsUpdateResponse, error)
- func (f Threads) ShellCommand(ctx context.Context, params protocolv2.ThreadShellCommandParams) (protocolv2.ThreadShellCommandResponse, error)
- func (f Threads) Start(ctx context.Context, params protocolv2.ThreadStartParams) (protocolv2.ThreadStartResponse, error)
- func (f Threads) TurnsList(ctx context.Context, params protocolv2.ThreadTurnsListParams) (protocolv2.ThreadTurnsListResponse, error)
- func (f Threads) Unarchive(ctx context.Context, params protocolv2.ThreadUnarchiveParams) (protocolv2.ThreadUnarchiveResponse, error)
- func (f Threads) Unsubscribe(ctx context.Context, params protocolv2.ThreadUnsubscribeParams) (protocolv2.ThreadUnsubscribeResponse, error)
- type TurnError
- type Turns
- func (f Turns) Interrupt(ctx context.Context, params protocolv2.TurnInterruptParams) (protocolv2.TurnInterruptResponse, error)
- func (f Turns) Start(ctx context.Context, params protocolv2.TurnStartParams) (protocolv2.TurnStartResponse, error)
- func (f Turns) Steer(ctx context.Context, params protocolv2.TurnSteerParams) (protocolv2.TurnSteerResponse, error)
- type WindowsSandbox
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ( ErrClientClosed = errors.New("codexsdk: client closed") ErrStreamClosed = errors.New("codexsdk: stream closed") ErrTurnFailed = errors.New("codexsdk: turn failed") ErrTurnInterrupted = errors.New("codexsdk: turn interrupted") ErrNotificationBackpressure = errors.New("codexsdk: notification backpressure") ErrHandlerFailed = errors.New("codexsdk: handler failed") ErrExactServerRequest = errors.New("codexsdk: exact server request failed closed") ErrMissingThreadID = errors.New("codexsdk: thread response missing thread id") ErrMissingTurnID = errors.New("codexsdk: turn response missing turn id") )
Functions ¶
This section is empty.
Types ¶
type Accounts ¶
type Accounts struct {
// contains filtered or unexported fields
}
Accounts is an opaque generated facade for exact Codex operations.
func (Accounts) LoginCancel ¶
func (f Accounts) LoginCancel(ctx context.Context, params protocolv2.CancelLoginAccountParams) (protocolv2.CancelLoginAccountResponse, error)
func (Accounts) LoginStart ¶
func (f Accounts) LoginStart(ctx context.Context, params protocolv2.LoginAccountParams) (protocolv2.LoginAccountResponse, error)
func (Accounts) Logout ¶
func (f Accounts) Logout(ctx context.Context) (protocolv2.LogoutAccountResponse, error)
func (Accounts) RateLimitResetCreditConsume ¶
func (f Accounts) RateLimitResetCreditConsume(ctx context.Context, params protocolv2.ConsumeAccountRateLimitResetCreditParams) (protocolv2.ConsumeAccountRateLimitResetCreditResponse, error)
func (Accounts) RateLimitsRead ¶
func (f Accounts) RateLimitsRead(ctx context.Context) (protocolv2.GetAccountRateLimitsResponse, error)
func (Accounts) Read ¶
func (f Accounts) Read(ctx context.Context, params protocolv2.GetAccountParams) (protocolv2.GetAccountResponse, error)
func (Accounts) SendAddCreditsNudgeEmail ¶
func (f Accounts) SendAddCreditsNudgeEmail(ctx context.Context, params protocolv2.SendAddCreditsNudgeEmailParams) (protocolv2.SendAddCreditsNudgeEmailResponse, error)
func (Accounts) WorkspaceMessagesRead ¶
func (f Accounts) WorkspaceMessagesRead(ctx context.Context) (protocolv2.GetWorkspaceMessagesResponse, error)
type Apps ¶
type Apps struct {
// contains filtered or unexported fields
}
Apps is an opaque generated facade for exact Codex operations.
func (Apps) List ¶
func (f Apps) List(ctx context.Context, params protocolv2.AppsListParams) (protocolv2.AppsListResponse, error)
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client owns one Codex app-server process and its transport, callbacks, and exact generated protocol facades. Construct connected clients with New. The zero value is safe but inert.
func New ¶
func New(options ClientOptions) (*Client, error)
func (*Client) CollaborationModes ¶
func (c *Client) CollaborationModes() CollaborationModes
func (*Client) ConfigRequirements ¶
func (c *Client) ConfigRequirements() ConfigRequirements
func (*Client) Environments ¶
func (c *Client) Environments() Environments
func (*Client) ExperimentalFeatures ¶
func (c *Client) ExperimentalFeatures() ExperimentalFeatures
func (*Client) ExternalAgentConfigs ¶
func (c *Client) ExternalAgentConfigs() ExternalAgentConfigs
func (*Client) FuzzyFileSearch ¶
func (c *Client) FuzzyFileSearch() FuzzyFileSearch
func (*Client) MCPServerStatus ¶
func (c *Client) MCPServerStatus() MCPServerStatus
func (*Client) MCPServers ¶
func (c *Client) MCPServers() MCPServers
func (*Client) Marketplace ¶
func (c *Client) Marketplace() Marketplace
func (*Client) ModelProviders ¶
func (c *Client) ModelProviders() ModelProviders
func (*Client) RemoteControl ¶
func (c *Client) RemoteControl() RemoteControl
func (*Client) ThreadRunner ¶
func (c *Client) ThreadRunner() ThreadRunner
func (*Client) WindowsSandbox ¶
func (c *Client) WindowsSandbox() WindowsSandbox
type ClientOptions ¶
type ClientOptions struct {
CWD string
Command []string
Initialize protocolv2.InitializeParams
ServerRequestHandler ServerRequestHandler
ServerNotificationHandler ServerNotificationHandler
NotificationQueueCapacity int
}
type CollaborationModes ¶
type CollaborationModes struct {
// contains filtered or unexported fields
}
CollaborationModes is an opaque generated facade for exact Codex operations.
func (CollaborationModes) List ¶
func (f CollaborationModes) List(ctx context.Context, params protocolv2.CollaborationModeListParams) (protocolv2.CollaborationModeListResponse, error)
type Commands ¶
type Commands struct {
// contains filtered or unexported fields
}
Commands is an opaque generated facade for exact Codex operations.
func (Commands) Exec ¶
func (f Commands) Exec(ctx context.Context, params protocolv2.CommandExecParams) (protocolv2.CommandExecResponse, error)
func (Commands) ExecResize ¶
func (f Commands) ExecResize(ctx context.Context, params protocolv2.CommandExecResizeParams) (protocolv2.CommandExecResizeResponse, error)
func (Commands) ExecTerminate ¶
func (f Commands) ExecTerminate(ctx context.Context, params protocolv2.CommandExecTerminateParams) (protocolv2.CommandExecTerminateResponse, error)
func (Commands) ExecWrite ¶
func (f Commands) ExecWrite(ctx context.Context, params protocolv2.CommandExecWriteParams) (protocolv2.CommandExecWriteResponse, error)
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config is an opaque generated facade for exact Codex operations.
func (Config) BatchWrite ¶
func (f Config) BatchWrite(ctx context.Context, params protocolv2.ConfigBatchWriteParams) (protocolv2.ConfigWriteResponse, error)
func (Config) MCPServerReload ¶
func (f Config) MCPServerReload(ctx context.Context) (protocolv2.McpServerRefreshResponse, error)
func (Config) Read ¶
func (f Config) Read(ctx context.Context, params protocolv2.ConfigReadParams) (protocolv2.ConfigReadResponse, error)
func (Config) ValueWrite ¶
func (f Config) ValueWrite(ctx context.Context, params protocolv2.ConfigValueWriteParams) (protocolv2.ConfigWriteResponse, error)
type ConfigRequirements ¶
type ConfigRequirements struct {
// contains filtered or unexported fields
}
ConfigRequirements is an opaque generated facade for exact Codex operations.
func (ConfigRequirements) Read ¶
func (f ConfigRequirements) Read(ctx context.Context) (protocolv2.ConfigRequirementsReadResponse, error)
type DiagnosticRef ¶
type Environments ¶
type Environments struct {
// contains filtered or unexported fields
}
Environments is an opaque generated facade for exact Codex operations.
func (Environments) Add ¶
func (f Environments) Add(ctx context.Context, params protocolv2.EnvironmentAddParams) (protocolv2.EnvironmentAddResponse, error)
type ExactServerRequestError ¶
type ExactServerRequestError struct {
Kind protocolv2.ServerRequestKind
Reason string
}
func (*ExactServerRequestError) Error ¶
func (e *ExactServerRequestError) Error() string
func (*ExactServerRequestError) Unwrap ¶
func (e *ExactServerRequestError) Unwrap() error
type ExperimentalFeatures ¶
type ExperimentalFeatures struct {
// contains filtered or unexported fields
}
ExperimentalFeatures is an opaque generated facade for exact Codex operations.
func (ExperimentalFeatures) EnablementSet ¶
func (f ExperimentalFeatures) EnablementSet(ctx context.Context, params protocolv2.ExperimentalFeatureEnablementSetParams) (protocolv2.ExperimentalFeatureEnablementSetResponse, error)
func (ExperimentalFeatures) List ¶
func (f ExperimentalFeatures) List(ctx context.Context, params protocolv2.ExperimentalFeatureListParams) (protocolv2.ExperimentalFeatureListResponse, error)
type ExternalAgentConfigs ¶
type ExternalAgentConfigs struct {
// contains filtered or unexported fields
}
ExternalAgentConfigs is an opaque generated facade for exact Codex operations.
func (ExternalAgentConfigs) Detect ¶
func (f ExternalAgentConfigs) Detect(ctx context.Context, params protocolv2.ExternalAgentConfigDetectParams) (protocolv2.ExternalAgentConfigDetectResponse, error)
func (ExternalAgentConfigs) Import ¶
func (f ExternalAgentConfigs) Import(ctx context.Context, params protocolv2.ExternalAgentConfigImportParams) (protocolv2.ExternalAgentConfigImportResponse, error)
func (ExternalAgentConfigs) ImportReadHistories ¶
func (f ExternalAgentConfigs) ImportReadHistories(ctx context.Context) (protocolv2.ExternalAgentConfigImportHistoriesReadResponse, error)
type FS ¶
type FS struct {
// contains filtered or unexported fields
}
FS is an opaque generated facade for exact Codex operations.
func (FS) Copy ¶
func (f FS) Copy(ctx context.Context, params protocolv2.FsCopyParams) (protocolv2.FsCopyResponse, error)
func (FS) CreateDirectory ¶
func (f FS) CreateDirectory(ctx context.Context, params protocolv2.FsCreateDirectoryParams) (protocolv2.FsCreateDirectoryResponse, error)
func (FS) GetMetadata ¶
func (f FS) GetMetadata(ctx context.Context, params protocolv2.FsGetMetadataParams) (protocolv2.FsGetMetadataResponse, error)
func (FS) ReadDirectory ¶
func (f FS) ReadDirectory(ctx context.Context, params protocolv2.FsReadDirectoryParams) (protocolv2.FsReadDirectoryResponse, error)
func (FS) ReadFile ¶
func (f FS) ReadFile(ctx context.Context, params protocolv2.FsReadFileParams) (protocolv2.FsReadFileResponse, error)
func (FS) Remove ¶
func (f FS) Remove(ctx context.Context, params protocolv2.FsRemoveParams) (protocolv2.FsRemoveResponse, error)
func (FS) Unwatch ¶
func (f FS) Unwatch(ctx context.Context, params protocolv2.FsUnwatchParams) (protocolv2.FsUnwatchResponse, error)
func (FS) Watch ¶
func (f FS) Watch(ctx context.Context, params protocolv2.FsWatchParams) (protocolv2.FsWatchResponse, error)
func (FS) WriteFile ¶
func (f FS) WriteFile(ctx context.Context, params protocolv2.FsWriteFileParams) (protocolv2.FsWriteFileResponse, error)
type Feedback ¶
type Feedback struct {
// contains filtered or unexported fields
}
Feedback is an opaque generated facade for exact Codex operations.
func (Feedback) Upload ¶
func (f Feedback) Upload(ctx context.Context, params protocolv2.FeedbackUploadParams) (protocolv2.FeedbackUploadResponse, error)
type FuzzyFileSearch ¶
type FuzzyFileSearch struct {
// contains filtered or unexported fields
}
FuzzyFileSearch is an opaque generated facade for exact Codex operations.
func (FuzzyFileSearch) Search ¶
func (f FuzzyFileSearch) Search(ctx context.Context, params protocolv2.FuzzyFileSearchParams) (protocolv2.FuzzyFileSearchResponse, error)
func (FuzzyFileSearch) SessionStart ¶
func (f FuzzyFileSearch) SessionStart(ctx context.Context, params protocolv2.FuzzyFileSearchSessionStartParams) (protocolv2.FuzzyFileSearchSessionStartResponse, error)
func (FuzzyFileSearch) SessionStop ¶
func (f FuzzyFileSearch) SessionStop(ctx context.Context, params protocolv2.FuzzyFileSearchSessionStopParams) (protocolv2.FuzzyFileSearchSessionStopResponse, error)
func (FuzzyFileSearch) SessionUpdate ¶
func (f FuzzyFileSearch) SessionUpdate(ctx context.Context, params protocolv2.FuzzyFileSearchSessionUpdateParams) (protocolv2.FuzzyFileSearchSessionUpdateResponse, error)
type Hooks ¶
type Hooks struct {
// contains filtered or unexported fields
}
Hooks is an opaque generated facade for exact Codex operations.
func (Hooks) List ¶
func (f Hooks) List(ctx context.Context, params protocolv2.HooksListParams) (protocolv2.HooksListResponse, error)
type InputStats ¶
type MCPServerStatus ¶
type MCPServerStatus struct {
// contains filtered or unexported fields
}
MCPServerStatus is an opaque generated facade for exact Codex operations.
func (MCPServerStatus) List ¶
func (f MCPServerStatus) List(ctx context.Context, params protocolv2.ListMcpServerStatusParams) (protocolv2.ListMcpServerStatusResponse, error)
type MCPServers ¶
type MCPServers struct {
// contains filtered or unexported fields
}
MCPServers is an opaque generated facade for exact Codex operations.
func (MCPServers) OAuthLogin ¶
func (f MCPServers) OAuthLogin(ctx context.Context, params protocolv2.McpServerOauthLoginParams) (protocolv2.McpServerOauthLoginResponse, error)
func (MCPServers) ResourceRead ¶
func (f MCPServers) ResourceRead(ctx context.Context, params protocolv2.McpResourceReadParams) (protocolv2.McpResourceReadResponse, error)
func (MCPServers) ToolCall ¶
func (f MCPServers) ToolCall(ctx context.Context, params protocolv2.McpServerToolCallParams) (protocolv2.McpServerToolCallResponse, error)
type Marketplace ¶
type Marketplace struct {
// contains filtered or unexported fields
}
Marketplace is an opaque generated facade for exact Codex operations.
func (Marketplace) Add ¶
func (f Marketplace) Add(ctx context.Context, params protocolv2.MarketplaceAddParams) (protocolv2.MarketplaceAddResponse, error)
func (Marketplace) Remove ¶
func (f Marketplace) Remove(ctx context.Context, params protocolv2.MarketplaceRemoveParams) (protocolv2.MarketplaceRemoveResponse, error)
func (Marketplace) Upgrade ¶
func (f Marketplace) Upgrade(ctx context.Context, params protocolv2.MarketplaceUpgradeParams) (protocolv2.MarketplaceUpgradeResponse, error)
type Memory ¶
type Memory struct {
// contains filtered or unexported fields
}
Memory is an opaque generated facade for exact Codex operations.
func (Memory) Reset ¶
func (f Memory) Reset(ctx context.Context) (protocolv2.MemoryResetResponse, error)
type Mock ¶
type Mock struct {
// contains filtered or unexported fields
}
Mock is an opaque generated facade for exact Codex operations.
func (Mock) ExperimentalMethod ¶
func (f Mock) ExperimentalMethod(ctx context.Context, params protocolv2.MockExperimentalMethodParams) (protocolv2.MockExperimentalMethodResponse, error)
type ModelProviders ¶
type ModelProviders struct {
// contains filtered or unexported fields
}
ModelProviders is an opaque generated facade for exact Codex operations.
func (ModelProviders) CapabilitiesRead ¶
func (f ModelProviders) CapabilitiesRead(ctx context.Context, params protocolv2.ModelProviderCapabilitiesReadParams) (protocolv2.ModelProviderCapabilitiesReadResponse, error)
type Models ¶
type Models struct {
// contains filtered or unexported fields
}
Models is an opaque generated facade for exact Codex operations.
func (Models) List ¶
func (f Models) List(ctx context.Context, params protocolv2.ModelListParams) (protocolv2.ModelListResponse, error)
type Plugins ¶
type Plugins struct {
// contains filtered or unexported fields
}
Plugins is an opaque generated facade for exact Codex operations.
func (Plugins) Install ¶
func (f Plugins) Install(ctx context.Context, params protocolv2.PluginInstallParams) (protocolv2.PluginInstallResponse, error)
func (Plugins) Installed ¶
func (f Plugins) Installed(ctx context.Context, params protocolv2.PluginInstalledParams) (protocolv2.PluginInstalledResponse, error)
func (Plugins) List ¶
func (f Plugins) List(ctx context.Context, params protocolv2.PluginListParams) (protocolv2.PluginListResponse, error)
func (Plugins) Read ¶
func (f Plugins) Read(ctx context.Context, params protocolv2.PluginReadParams) (protocolv2.PluginReadResponse, error)
func (Plugins) ShareCheckout ¶
func (f Plugins) ShareCheckout(ctx context.Context, params protocolv2.PluginShareCheckoutParams) (protocolv2.PluginShareCheckoutResponse, error)
func (Plugins) ShareDelete ¶
func (f Plugins) ShareDelete(ctx context.Context, params protocolv2.PluginShareDeleteParams) (protocolv2.PluginShareDeleteResponse, error)
func (Plugins) ShareList ¶
func (f Plugins) ShareList(ctx context.Context, params protocolv2.PluginShareListParams) (protocolv2.PluginShareListResponse, error)
func (Plugins) ShareSave ¶
func (f Plugins) ShareSave(ctx context.Context, params protocolv2.PluginShareSaveParams) (protocolv2.PluginShareSaveResponse, error)
func (Plugins) ShareUpdateTargets ¶
func (f Plugins) ShareUpdateTargets(ctx context.Context, params protocolv2.PluginShareUpdateTargetsParams) (protocolv2.PluginShareUpdateTargetsResponse, error)
func (Plugins) SkillRead ¶
func (f Plugins) SkillRead(ctx context.Context, params protocolv2.PluginSkillReadParams) (protocolv2.PluginSkillReadResponse, error)
func (Plugins) Uninstall ¶
func (f Plugins) Uninstall(ctx context.Context, params protocolv2.PluginUninstallParams) (protocolv2.PluginUninstallResponse, error)
type Processes ¶
type Processes struct {
// contains filtered or unexported fields
}
Processes is an opaque generated facade for exact Codex operations.
func (Processes) Kill ¶
func (f Processes) Kill(ctx context.Context, params protocolv2.ProcessKillParams) (protocolv2.ProcessKillResponse, error)
func (Processes) ResizePTY ¶
func (f Processes) ResizePTY(ctx context.Context, params protocolv2.ProcessResizePtyParams) (protocolv2.ProcessResizePtyResponse, error)
func (Processes) Spawn ¶
func (f Processes) Spawn(ctx context.Context, params protocolv2.ProcessSpawnParams) (protocolv2.ProcessSpawnResponse, error)
func (Processes) WriteStdin ¶
func (f Processes) WriteStdin(ctx context.Context, params protocolv2.ProcessWriteStdinParams) (protocolv2.ProcessWriteStdinResponse, error)
type ProtocolError ¶
type ProtocolError struct {
RequestID protocolv2.RequestId
Method string
Code int64
Message string
Data *protocolv2.JSONValue
Err error
}
func (*ProtocolError) Error ¶
func (e *ProtocolError) Error() string
func (*ProtocolError) Unwrap ¶
func (e *ProtocolError) Unwrap() error
type RemoteControl ¶
type RemoteControl struct {
// contains filtered or unexported fields
}
RemoteControl is an opaque generated facade for exact Codex operations.
func (RemoteControl) ClientRevoke ¶
func (f RemoteControl) ClientRevoke(ctx context.Context, params protocolv2.RemoteControlClientsRevokeParams) (protocolv2.RemoteControlClientsRevokeResponse, error)
func (RemoteControl) Disable ¶
func (f RemoteControl) Disable(ctx context.Context) (protocolv2.RemoteControlDisableResponse, error)
func (RemoteControl) Enable ¶
func (f RemoteControl) Enable(ctx context.Context) (protocolv2.RemoteControlEnableResponse, error)
func (RemoteControl) PairingStart ¶
func (f RemoteControl) PairingStart(ctx context.Context, params protocolv2.RemoteControlPairingStartParams) (protocolv2.RemoteControlPairingStartResponse, error)
func (RemoteControl) PairingStatus ¶
func (f RemoteControl) PairingStatus(ctx context.Context, params protocolv2.RemoteControlPairingStatusParams) (protocolv2.RemoteControlPairingStatusResponse, error)
func (RemoteControl) StatusRead ¶
func (f RemoteControl) StatusRead(ctx context.Context) (protocolv2.RemoteControlStatusReadResponse, error)
type ResumeThreadRunRequest ¶
type ResumeThreadRunRequest struct {
Thread protocolv2.ThreadResumeParams
Turn protocolv2.TurnStartParams
}
type ResumedThreadRun ¶
type ResumedThreadRun struct {
Resume protocolv2.ThreadResumeResponse
Run ThreadRunResult
}
type Reviews ¶
type Reviews struct {
// contains filtered or unexported fields
}
Reviews is an opaque generated facade for exact Codex operations.
func (Reviews) Start ¶
func (f Reviews) Start(ctx context.Context, params protocolv2.ReviewStartParams) (protocolv2.ReviewStartResponse, error)
type ServerNotificationHandler ¶
type ServerNotificationHandler func(context.Context, protocolv2.ServerNotification) error
type ServerRequestHandler ¶
type ServerRequestHandler func(context.Context, protocolv2.ServerRequest) (ServerRequestResponse, error)
type ServerRequestResponse ¶
type ServerRequestResponse struct {
// contains filtered or unexported fields
}
func ApplyPatchApprovalResponse ¶
func ApplyPatchApprovalResponse(value protocolv2.ApplyPatchApprovalResponse) ServerRequestResponse
func AttestationResponse ¶
func AttestationResponse(value protocolv2.AttestationGenerateResponse) ServerRequestResponse
func ChatGPTAuthRefreshResponse ¶
func ChatGPTAuthRefreshResponse(value protocolv2.ChatgptAuthTokensRefreshResponse) ServerRequestResponse
func CommandExecutionApprovalResponse ¶
func CommandExecutionApprovalResponse(value protocolv2.CommandExecutionRequestApprovalResponse) ServerRequestResponse
func CurrentTimeResponse ¶
func CurrentTimeResponse(value protocolv2.CurrentTimeReadResponse) ServerRequestResponse
func DynamicToolResponse ¶
func DynamicToolResponse(value protocolv2.DynamicToolCallResponse) ServerRequestResponse
func ExecCommandApprovalResponse ¶
func ExecCommandApprovalResponse(value protocolv2.ExecCommandApprovalResponse) ServerRequestResponse
func FileChangeApprovalResponse ¶
func FileChangeApprovalResponse(value protocolv2.FileChangeRequestApprovalResponse) ServerRequestResponse
func MCPElicitationResponse ¶
func MCPElicitationResponse(value protocolv2.McpServerElicitationRequestResponse) ServerRequestResponse
func PermissionsApprovalResponse ¶
func PermissionsApprovalResponse(value protocolv2.PermissionsRequestApprovalResponse) ServerRequestResponse
func ToolUserInputResponse ¶
func ToolUserInputResponse(value protocolv2.ToolRequestUserInputResponse) ServerRequestResponse
type Skills ¶
type Skills struct {
// contains filtered or unexported fields
}
Skills is an opaque generated facade for exact Codex operations.
func (Skills) ConfigWrite ¶
func (f Skills) ConfigWrite(ctx context.Context, params protocolv2.SkillsConfigWriteParams) (protocolv2.SkillsConfigWriteResponse, error)
func (Skills) ExtraRootsSet ¶
func (f Skills) ExtraRootsSet(ctx context.Context, params protocolv2.SkillsExtraRootsSetParams) (protocolv2.SkillsExtraRootsSetResponse, error)
func (Skills) List ¶
func (f Skills) List(ctx context.Context, params protocolv2.SkillsListParams) (protocolv2.SkillsListResponse, error)
type StartThreadRunRequest ¶
type StartThreadRunRequest struct {
Thread protocolv2.ThreadStartParams
Turn protocolv2.TurnStartParams
}
type StartedThreadRun ¶
type StartedThreadRun struct {
Start protocolv2.ThreadStartResponse
Run ThreadRunResult
}
type Stream ¶
type Stream[R any] struct { // contains filtered or unexported fields }
func (*Stream[R]) Notification ¶
func (s *Stream[R]) Notification() protocolv2.ServerNotification
func (*Stream[R]) Wait ¶
Wait observes run completion without consuming notifications or owning the run lifecycle. Context cancellation stops only this call and returns the latest immutable partial result; use Close to cancel the shared run.
Example ¶
package main
import (
"context"
"os"
"github.com/ronhuafeng/llm-go/codexsdk"
"github.com/ronhuafeng/llm-go/codexsdk/protocolv2"
)
func main() {
ctx := context.Background()
root, err := codexsdk.New(codexsdk.ClientOptions{
CWD: os.TempDir(),
Command: []string{"codex", "app-server", "--listen", "stdio://"},
})
if err != nil {
panic(err)
}
defer root.Close()
stream, err := root.ThreadRunner().StartStream(ctx, codexsdk.StartThreadRunRequest{
Turn: protocolv2.TurnStartParams{Input: []protocolv2.UserInput{
protocolv2.NewUserInputText(protocolv2.UserInputText{Text: "Reply briefly."}),
}},
})
if err != nil {
panic(err)
}
defer stream.Close()
result, err := stream.Wait(ctx)
if err != nil {
// Result retains exact evidence accepted before failure.
panic(err)
}
_ = result.Run.Notifications
}
Output:
type ThreadRunResult ¶
type ThreadRunResult struct {
Turn protocolv2.Turn
Usage *protocolv2.ThreadTokenUsage
Notifications []protocolv2.ServerNotification
FinalResponse string
InputStats InputStats
Diagnostics []DiagnosticRef
}
type ThreadRunner ¶
type ThreadRunner interface {
Start(context.Context, StartThreadRunRequest) (StartedThreadRun, error)
Resume(context.Context, ResumeThreadRunRequest) (ResumedThreadRun, error)
StartStream(context.Context, StartThreadRunRequest) (*Stream[StartedThreadRun], error)
ResumeStream(context.Context, ResumeThreadRunRequest) (*Stream[ResumedThreadRun], error)
}
Example (Start) ¶
package main
import (
"context"
"os"
"github.com/ronhuafeng/llm-go/codexsdk"
"github.com/ronhuafeng/llm-go/codexsdk/protocolv2"
)
func main() {
ctx := context.Background()
root, err := codexsdk.New(codexsdk.ClientOptions{
CWD: os.TempDir(),
Command: []string{"codex", "app-server", "--listen", "stdio://"},
})
if err != nil {
panic(err)
}
defer root.Close()
result, err := root.ThreadRunner().Start(ctx, codexsdk.StartThreadRunRequest{
Thread: protocolv2.ThreadStartParams{Model: protocolv2.Value("gpt-5")},
Turn: protocolv2.TurnStartParams{Input: []protocolv2.UserInput{
protocolv2.NewUserInputText(protocolv2.UserInputText{Text: "Reply briefly."}),
}},
})
if err != nil {
panic(err)
}
_ = result.Run.FinalResponse
_ = result.Run.Notifications
}
Output:
type Threads ¶
type Threads struct {
// contains filtered or unexported fields
}
Threads is an opaque generated facade for exact Codex operations.
func (Threads) ApproveGuardianDeniedAction ¶
func (f Threads) ApproveGuardianDeniedAction(ctx context.Context, params protocolv2.ThreadApproveGuardianDeniedActionParams) (protocolv2.ThreadApproveGuardianDeniedActionResponse, error)
func (Threads) Archive ¶
func (f Threads) Archive(ctx context.Context, params protocolv2.ThreadArchiveParams) (protocolv2.ThreadArchiveResponse, error)
func (Threads) BackgroundTerminalsClean ¶
func (f Threads) BackgroundTerminalsClean(ctx context.Context, params protocolv2.ThreadBackgroundTerminalsCleanParams) (protocolv2.ThreadBackgroundTerminalsCleanResponse, error)
func (Threads) BackgroundTerminalsTerminate ¶
func (f Threads) BackgroundTerminalsTerminate(ctx context.Context, params protocolv2.ThreadBackgroundTerminalsTerminateParams) (protocolv2.ThreadBackgroundTerminalsTerminateResponse, error)
func (Threads) CompactStart ¶
func (f Threads) CompactStart(ctx context.Context, params protocolv2.ThreadCompactStartParams) (protocolv2.ThreadCompactStartResponse, error)
func (Threads) DecrementElicitation ¶
func (f Threads) DecrementElicitation(ctx context.Context, params protocolv2.ThreadDecrementElicitationParams) (protocolv2.ThreadDecrementElicitationResponse, error)
func (Threads) Delete ¶
func (f Threads) Delete(ctx context.Context, params protocolv2.ThreadDeleteParams) (protocolv2.ThreadDeleteResponse, error)
func (Threads) Fork ¶
func (f Threads) Fork(ctx context.Context, params protocolv2.ThreadForkParams) (protocolv2.ThreadForkResponse, error)
func (Threads) GoalClear ¶
func (f Threads) GoalClear(ctx context.Context, params protocolv2.ThreadGoalClearParams) (protocolv2.ThreadGoalClearResponse, error)
func (Threads) GoalGet ¶
func (f Threads) GoalGet(ctx context.Context, params protocolv2.ThreadGoalGetParams) (protocolv2.ThreadGoalGetResponse, error)
func (Threads) GoalSet ¶
func (f Threads) GoalSet(ctx context.Context, params protocolv2.ThreadGoalSetParams) (protocolv2.ThreadGoalSetResponse, error)
func (Threads) IncrementElicitation ¶
func (f Threads) IncrementElicitation(ctx context.Context, params protocolv2.ThreadIncrementElicitationParams) (protocolv2.ThreadIncrementElicitationResponse, error)
func (Threads) InjectItems ¶
func (f Threads) InjectItems(ctx context.Context, params protocolv2.ThreadInjectItemsParams) (protocolv2.ThreadInjectItemsResponse, error)
func (Threads) ItemsList ¶
func (f Threads) ItemsList(ctx context.Context, params protocolv2.ThreadItemsListParams) (protocolv2.ThreadItemsListResponse, error)
func (Threads) List ¶
func (f Threads) List(ctx context.Context, params protocolv2.ThreadListParams) (protocolv2.ThreadListResponse, error)
func (Threads) LoadedList ¶
func (f Threads) LoadedList(ctx context.Context, params protocolv2.ThreadLoadedListParams) (protocolv2.ThreadLoadedListResponse, error)
func (Threads) MemoryModeSet ¶
func (f Threads) MemoryModeSet(ctx context.Context, params protocolv2.ThreadMemoryModeSetParams) (protocolv2.ThreadMemoryModeSetResponse, error)
func (Threads) MetadataUpdate ¶
func (f Threads) MetadataUpdate(ctx context.Context, params protocolv2.ThreadMetadataUpdateParams) (protocolv2.ThreadMetadataUpdateResponse, error)
func (Threads) NameSet ¶
func (f Threads) NameSet(ctx context.Context, params protocolv2.ThreadSetNameParams) (protocolv2.ThreadSetNameResponse, error)
func (Threads) Read ¶
func (f Threads) Read(ctx context.Context, params protocolv2.ThreadReadParams) (protocolv2.ThreadReadResponse, error)
func (Threads) RealtimeAppendAudio ¶
func (f Threads) RealtimeAppendAudio(ctx context.Context, params protocolv2.ThreadRealtimeAppendAudioParams) (protocolv2.ThreadRealtimeAppendAudioResponse, error)
func (Threads) RealtimeAppendSpeech ¶
func (f Threads) RealtimeAppendSpeech(ctx context.Context, params protocolv2.ThreadRealtimeAppendSpeechParams) (protocolv2.ThreadRealtimeAppendSpeechResponse, error)
func (Threads) RealtimeAppendText ¶
func (f Threads) RealtimeAppendText(ctx context.Context, params protocolv2.ThreadRealtimeAppendTextParams) (protocolv2.ThreadRealtimeAppendTextResponse, error)
func (Threads) RealtimeListVoices ¶
func (f Threads) RealtimeListVoices(ctx context.Context, params protocolv2.ThreadRealtimeListVoicesParams) (protocolv2.ThreadRealtimeListVoicesResponse, error)
func (Threads) RealtimeStart ¶
func (f Threads) RealtimeStart(ctx context.Context, params protocolv2.ThreadRealtimeStartParams) (protocolv2.ThreadRealtimeStartResponse, error)
func (Threads) RealtimeStop ¶
func (f Threads) RealtimeStop(ctx context.Context, params protocolv2.ThreadRealtimeStopParams) (protocolv2.ThreadRealtimeStopResponse, error)
func (Threads) Resume ¶
func (f Threads) Resume(ctx context.Context, params protocolv2.ThreadResumeParams) (protocolv2.ThreadResumeResponse, error)
func (Threads) Rollback ¶
func (f Threads) Rollback(ctx context.Context, params protocolv2.ThreadRollbackParams) (protocolv2.ThreadRollbackResponse, error)
func (Threads) SettingsUpdate ¶
func (f Threads) SettingsUpdate(ctx context.Context, params protocolv2.ThreadSettingsUpdateParams) (protocolv2.ThreadSettingsUpdateResponse, error)
func (Threads) ShellCommand ¶
func (f Threads) ShellCommand(ctx context.Context, params protocolv2.ThreadShellCommandParams) (protocolv2.ThreadShellCommandResponse, error)
func (Threads) Start ¶
func (f Threads) Start(ctx context.Context, params protocolv2.ThreadStartParams) (protocolv2.ThreadStartResponse, error)
func (Threads) TurnsList ¶
func (f Threads) TurnsList(ctx context.Context, params protocolv2.ThreadTurnsListParams) (protocolv2.ThreadTurnsListResponse, error)
func (Threads) Unarchive ¶
func (f Threads) Unarchive(ctx context.Context, params protocolv2.ThreadUnarchiveParams) (protocolv2.ThreadUnarchiveResponse, error)
func (Threads) Unsubscribe ¶
func (f Threads) Unsubscribe(ctx context.Context, params protocolv2.ThreadUnsubscribeParams) (protocolv2.ThreadUnsubscribeResponse, error)
type Turns ¶
type Turns struct {
// contains filtered or unexported fields
}
Turns is an opaque generated facade for exact Codex operations.
func (Turns) Interrupt ¶
func (f Turns) Interrupt(ctx context.Context, params protocolv2.TurnInterruptParams) (protocolv2.TurnInterruptResponse, error)
func (Turns) Start ¶
func (f Turns) Start(ctx context.Context, params protocolv2.TurnStartParams) (protocolv2.TurnStartResponse, error)
func (Turns) Steer ¶
func (f Turns) Steer(ctx context.Context, params protocolv2.TurnSteerParams) (protocolv2.TurnSteerResponse, error)
type WindowsSandbox ¶
type WindowsSandbox struct {
// contains filtered or unexported fields
}
WindowsSandbox is an opaque generated facade for exact Codex operations.
func (WindowsSandbox) Readiness ¶
func (f WindowsSandbox) Readiness(ctx context.Context) (protocolv2.WindowsSandboxReadinessResponse, error)
func (WindowsSandbox) SetupStart ¶
func (f WindowsSandbox) SetupStart(ctx context.Context, params protocolv2.WindowsSandboxSetupStartParams) (protocolv2.WindowsSandboxSetupStartResponse, error)
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
cmd/apiinventoryreport
command
|
|
|
cmd/protocolv2gen
command
|
|
|
Package protocolv2 contains generated and handwritten Codex app-server v2 protocol types.
|
Package protocolv2 contains generated and handwritten Codex app-server v2 protocol types. |