bmaexecutor

package module

Go to main page

Versions in this module

v1

v1.2.0

Nov 8, 2026

Changes in this version

+ const MachineIDEnv

+ const MethodFsMount

+ const MethodFsUnmount

type AgentCapability

+ PlatformCredentials []string

type Capabilities

+ Fs *FsCapability

+ type FsCapability struct

+ Fuse bool

+ Views []string

+ type FsMount struct

+ Options map[string]string

+ Path string

+ Readonly bool

+ Token string

+ View string

+ type FsMountParams struct

+ Mounts []FsMount

+ ServiceURL string

+ SessionID string

+ type FsMountResult struct

+ Error string

+ ErrorCode string

+ State string

+ type FsUnmountParams struct

+ Flush bool

+ SessionID string

+ type FsUnmountResult struct

+ Error string

+ ErrorCode string

+ PendingBytes int64

+ State string

type Options

+ MachineID string

v1.1.0

Nov 7, 2026

Changes in this version

+ const MetadataAgentSessionID

+ const ReasonLocalConfirmationDenied

+ const ReasonLocalConfirmationExpired

+ const ReasonProcessIDSpecMismatch

+ const ReasonSessionRejected

+ const ReasonSpawnFailed

+ const ReasonWorkspaceBoundary

+ const ReasonWorkspaceReadOnly

+ const ReasonWorkspaceUnavailable

+ var ErrMachineTokenRequired = errors.New(...)

+ var ErrSessionContextNotFound = errors.New("bmaexecutor: session context not found")

type Capabilities

+ SessionFiles *SessionFilesCapability

type Client

+ func (c *Client) SessionContext(ctx context.Context, processID string) (SessionContext, error)

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

+ type DaemonHTTPError struct

+ Code string

+ Message string

+ StatusCode int

+ func (e *DaemonHTTPError) Error() string

+ type LaunchFunc func(ctx context.Context, req LaunchRequest) (LaunchSpec, error)

+ type LaunchRequest struct

+ Argv []string

+ Cwd string

+ DefaultCwd string

+ Env []string

+ PackageInstall *ProcessPackageInstall

+ type LaunchSpec struct

+ Argv []string

+ Dir string

+ Env []string

+ type ProcessContext struct

+ AgentSessionID string

+ Metadata map[string]string

+ ProcessID string

+ SessionID string

type ProcessOptions

+ Launch LaunchFunc

+ SessionFiles *SessionFiles

type RPCError

+ func NewReasonError(code int, reason, message string) *RPCError

+ type SessionContext struct

+ CreatedAt time.Time

+ EnvironmentID string

+ ID string

+ Metadata map[string]string

+ type SessionFileTransferer interface

+ TransferSessionFile func(ctx context.Context, process ProcessContext, transfer ProcessFileTransfer) (FileTransferResult, error)

+ type SessionFiles struct

+ func NewSessionFiles(opts SessionFilesOptions) (*SessionFiles, error)

+ func (f *SessionFiles) Dirs(sessionID string) (uploads, outputs string)

+ func (f *SessionFiles) Root() string

+ func (f *SessionFiles) Run(ctx context.Context)

+ type SessionFilesCapability struct

+ Root string

+ type SessionFilesOptions struct

+ MaxOutputBytes int64

+ OnLog func(LogEvent)

+ Root string

v1.0.5

Nov 7, 2026

v1.0.4

Nov 7, 2026

Changes in this version

+ var ErrRegistrationRefused = errors.New("bmaexecutor: executor registration refused")

type Client

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

v1.0.3

Nov 7, 2026

v1.0.2

Nov 7, 2026

Changes in this version

+ var ErrCredentialRejected = errors.New("bmaexecutor: executor credential rejected")

v1.0.1

Nov 6, 2026

v1.0.0

Nov 6, 2026

Changes in this version

+ var Calls = struct{ ... }

+ var Notifications = struct{ ... }

+ var Requests = struct{ ... }

type AgentCapability

+ Harness *AgentHarnessCapability

+ TurnResume bool

+ type AgentHarnessCapability struct

+ AgentName string

+ AgentVersion string

+ ID string

+ ImageInputs bool

+ PermissionRelay string

+ Protocol string

+ SessionLoad bool

+ SessionResume bool

+ Streaming string

+ StructuredErrors bool

+ Usage string

+ Version string

+ type BashInput struct

+ Command string

+ Cwd string

+ Env map[string]string

+ TimeoutMS int64

+ type BashResult struct

+ ExitCode int

+ Stderr string

+ Stdout string

+ Truncated bool

+ func (r BashResult) Output() ToolOutput

+ type CallMethod struct

+ Method string

+ func (m CallMethod[P, R]) Call(ctx context.Context, client *Client, params P) (R, error)

+ type CallToolOptions struct

+ DeadlineMS int64

+ Permission *ToolPermission

+ ToolCallID string

type Client

+ Tools Tools

+ type ComputerActionInput struct

+ Action string

+ Display string

+ type ComputerObserveInput struct

+ Display string

+ type EditInput struct

+ NewString string

+ OldString string

+ Path string

+ type GlobInput struct

+ Path string

+ Pattern string

+ type GrepInput struct

+ Glob string

+ Path string

+ Pattern string

+ type HarnessToolSlot struct

+ func (s HarnessToolSlot[In]) Call(ctx context.Context, input In, options CallToolOptions) (ToolResultParams, error)

+ type HarnessTools struct

+ Bash HarnessToolSlot[BashInput]

+ Edit HarnessToolSlot[EditInput]

+ Glob HarnessToolSlot[GlobInput]

+ Grep HarnessToolSlot[GrepInput]

+ ListFiles HarnessToolSlot[ListFilesInput]

+ Read HarnessToolSlot[ReadInput]

+ Write HarnessToolSlot[WriteInput]

+ type ListFilesInput struct

+ Path string

+ type NotificationMethod struct

+ Method string

+ func (m NotificationMethod[P]) Notify(ctx context.Context, client *Client, params P) error

+ type ReadInput struct

+ Limit int64

+ Offset int64

+ Path string

+ type RequestMethod struct

+ Method string

+ func (m RequestMethod[P, R]) Handle(client *Client, handler func(ctx context.Context, params P) (R, error))

type Session

+ Tools HarnessTools

+ type ToolContext struct

+ Permission *ToolPermission

+ Progress func(message string)

+ SessionID string

+ ToolCallID string

+ type ToolError struct

+ Content []ContentBlock

+ func NewToolError(text string) *ToolError

+ func (e *ToolError) Error() string

+ type ToolOutput struct

+ Artifacts []ArtifactRef

+ Content []ContentBlock

+ IsError bool

+ Outcome string

+ func TextOutput(text string) ToolOutput

+ type ToolSlot struct

+ func (s ToolSlot[In]) Handle(...)

+ type Tools struct

+ Bash ToolSlot[BashInput]

+ Edit ToolSlot[EditInput]

+ Glob ToolSlot[GlobInput]

+ Grep ToolSlot[GrepInput]

+ ListFiles ToolSlot[ListFilesInput]

+ Read ToolSlot[ReadInput]

+ Write ToolSlot[WriteInput]

+ type WriteInput struct

+ Content string

+ Path string

v0

v0.4.9

Nov 1, 2026

Changes in this version

+ const AgentEventTypeAgentMcpToolResult

+ const AgentEventTypeAgentMcpToolUse

+ const AgentEventTypeAgentMessage

+ const AgentEventTypeAgentThinking

+ const AgentEventTypeAgentToolResult

+ const AgentEventTypeAgentToolUse

+ const AgentEventTypeSessionError

+ const AgentEventTypeSessionStatusIdle

+ const AgentEventTypeSessionStatusRunning

+ const AgentInputBlockTypeFile

+ const AgentInputBlockTypeText

+ const ChannelControl

+ const ChannelMCP

+ const CodeCanceled

+ const CodeCapabilityUnavailable

+ const CodeConflict

+ const CodeExecutorBusy

+ const CodeForbidden

+ const CodeInternalError

+ const CodeInvalidParams

+ const CodeInvalidRequest

+ const CodeLeaseExpired

+ const CodeMCPUnavailable

+ const CodeMethodNotFound

+ const CodeNotFound

+ const CodeParseError

+ const CodePayloadTooLarge

+ const CodeResourceUnavailable

+ const CodeSessionNotActive

+ const CodeTimeout

+ const CodeUnauthorized

+ const CodeUnsupportedProtocol

+ const ComputerActionClick

+ const ComputerActionDrag

+ const ComputerActionKey

+ const ComputerActionScroll

+ const ComputerActionType

+ const ConnectionStateClosed

+ const ConnectionStateConnecting

+ const ConnectionStateDisconnected

+ const ConnectionStateDraining

+ const ConnectionStateReady

+ const ConnectionStateRegistered

+ const ContentBlockTypeArtifact

+ const ContentBlockTypeImage

+ const ContentBlockTypeResource

+ const ContentBlockTypeText

+ const DefaultBaseURL

+ const DefaultCoreBashTimeout

+ const DefaultCoreInlineResultBytes

+ const DefaultCoreMaxMCPServers

+ const DefaultCoreMaxOutputBytes

+ const DefaultCoreMaxSessions

+ const DefaultHarnessHeartbeatInterval

+ const DefaultHarnessLeaseTTL

+ const DefaultMaxArtifactBytes

+ const DefaultMaxReconnectAttempts

+ const DefaultReconnectBaseDelay

+ const DefaultRequestTimeout

+ const DefaultToolResultRetryAttempts

+ const DefaultToolResultRetryBaseDelay

+ const EventDeltaTypeAgentMessage

+ const EventDeltaTypeAgentThinking

+ const FileTransferDownload

+ const FileTransferUpload

+ const IOModePTY

+ const InteractionCancelReasonExpired

+ const InteractionCancelReasonResolvedLocally

+ const InteractionCancelReasonToolCanceled

+ const InteractionCancelReasonTurnCanceled

+ const InteractionKindPermission

+ const InteractionKindQuestion

+ const InteractionOutcomeAllow

+ const InteractionOutcomeAnswered

+ const InteractionOutcomeCanceled

+ const InteractionOutcomeDeny

+ const InteractionOutcomeExpired

+ const InteractionScopeOnce

+ const InteractionScopeSession

+ const MCPConnectionOriginEnvironment

+ const MCPConnectionOriginService

+ const MCPTransportTypeHttp

+ const MCPTransportTypeStdio

+ const MaxProcessesPerSession

+ const MethodExecutorCapabilitiesUpdate

+ const MethodExecutorClose

+ const MethodExecutorDrain

+ const MethodExecutorHeartbeat

+ const MethodExecutorRegister

+ const MethodExecutorTokenRefresh

+ const MethodInteractionCancel

+ const MethodInteractionRequest

+ const MethodInteractionResponse

+ const MethodProcessInterrupt

+ const MethodProcessList

+ const MethodProcessRead

+ const MethodProcessStart

+ const MethodProcessStatus

+ const MethodProcessTerminate

+ const MethodProcessWrite

+ const MethodSessionAssign

+ const MethodSessionClose

+ const MethodSessionEnded

+ const MethodSessionEvent

+ const MethodSessionEventDelta

+ const MethodSessionReady

+ const MethodSessionStatus

+ const MethodSessionStop

+ const MethodSkillInstall

+ const MethodTerminalAttach

+ const MethodTerminalClose

+ const MethodTerminalOpen

+ const MethodToolCall

+ const MethodToolCancel

+ const MethodToolProgress

+ const MethodToolResult

+ const MethodTurnCancel

+ const MethodTurnInput

+ const MethodTurnStart

+ const MethodWorkspaceBackup

+ const PackageManagerApt

+ const PackageManagerNpm

+ const PackageManagerPip

+ const PermissionModeAlwaysAllow

+ const PermissionModeAlwaysAsk

+ const ProcessBufferBytes

+ const ProcessExited

+ const ProcessFailed

+ const ProcessKilled

+ const ProcessRunning

+ const ProtocolV1

+ const ProtocolV11

+ const SessionEventTypeAgentMcpToolResult

+ const SessionEventTypeAgentMcpToolUse

+ const SessionEventTypeAgentMessage

+ const SessionEventTypeAgentThinking

+ const SessionEventTypeAgentToolResult

+ const SessionEventTypeAgentToolUse

+ const SessionEventTypeSessionError

+ const SessionEventTypeSessionStatusIdle

+ const SessionEventTypeSessionStatusRunning

+ const SessionStatusError

+ const SessionStatusIdle

+ const SessionStatusRunning

+ const SessionStatusStarting

+ const SessionStatusStopped

+ const SessionStatusStopping

+ const StderrMerge

+ const StdinClosed

+ const StdinOpen

+ const StopReasonTypeEndTurn

+ const StopReasonTypeRetriesExhausted

+ const StreamStderr

+ const StreamStdout

+ const ToolNameBash

+ const ToolNameComputerAction

+ const ToolNameComputerObserve

+ const ToolNameEdit

+ const ToolNameGlob

+ const ToolNameGrep

+ const ToolNameListFiles

+ const ToolNameRead

+ const ToolNameWrite

+ const ToolOutcomeCanceled

+ const ToolOutcomeFailed

+ const ToolOutcomeSucceeded

+ const TurnOutcomeCanceled

+ const TurnOutcomeCompleted

+ const TurnOutcomeFailed

+ var ErrAgentSessionClosed = errors.New("bmaexecutor: agent session closed")

+ var ErrAssignRejected = errors.New("bmaexecutor: executor rejected session.assign")

+ var ErrClientStopped = errors.New("bmaexecutor: client stopped")

+ var ErrNamedPipeUnsupported = errors.New("bmaexecutor: Windows named pipes are not supported on this platform")

+ var ErrNotConnected = errors.New("bmaexecutor: executor channel is not connected")

+ var ErrReconnectExhausted = errors.New("bmaexecutor: executor reconnect attempts exhausted")

+ var ErrReplaced = errors.New("bmaexecutor: executor connection was replaced (4004)")

+ var ErrSessionEnded = errors.New("bmaexecutor: session ended")

+ var ErrToolOutcomeUnknown = errors.New("bmaexecutor: tool outcome unknown: executor lost before tool.result")

+ var Methods = map[string]MethodSpec

+ func CloseCode(err error) int

+ func NamedPipeListener(name string) (net.Listener, error)

+ func NewParams(method string) any

+ func NewResult(method string) any

+ func NewToolInput(input ToolInput) json.RawMessage

+ func Pipe(protocol string) (executor Conn, harness Conn)

+ func RequestID(ctx context.Context) string

+ func SendExecutorCapabilitiesUpdate(ctx context.Context, rpc RPC, params ExecutorCapabilitiesUpdateParams) error

+ func SendExecutorClose(ctx context.Context, rpc RPC, params ExecutorCloseParams) error

+ func SendProcessStatus(ctx context.Context, rpc RPC, params ProcessStatusParams) error

+ func SendSessionEventDelta(ctx context.Context, rpc RPC, params SessionEventDeltaParams) error

+ func SendSessionStatus(ctx context.Context, rpc RPC, params SessionStatusParams) error

+ func SendToolProgress(ctx context.Context, rpc RPC, params ToolProgressParams) error

+ func StaticToken(wsURL, token string) func(context.Context) (ExecutorTokenResponse, error)

+ type Ack struct

+ Accepted bool

+ func SendInteractionCancel(ctx context.Context, rpc RPC, params InteractionCancelParams) (Ack, error)

+ func SendSessionEnded(ctx context.Context, rpc RPC, params SessionEndedParams) (Ack, error)

+ func SendSessionReady(ctx context.Context, rpc RPC, params SessionReadyParams) (Ack, error)

+ func SendToolResult(ctx context.Context, rpc RPC, params ToolResultParams) (Ack, error)

+ type AgentCapability struct

+ Enabled bool

+ FileInputs bool

+ InteractionKinds []string

+ MaxSessions int64

+ Models []AgentModel

+ PermissionModes []string

+ type AgentErrorInfo struct

+ Message string

+ Type string

+ type AgentEventRecord struct

+ Event json.RawMessage

+ EventID string

+ Sequence int64

+ SessionID string

+ TurnID string

+ Type string

+ type AgentHandler interface

+ CloseSession func(ctx context.Context, sessionID, reason string) error

+ OpenTurn func(ctx context.Context, params TurnStartParams) (TurnStartResult, error)

+ RunTurn func(ctx context.Context, turn *AgentTurn) error

+ type AgentInputBlock struct

+ FileID string

+ MimeType string

+ Name string

+ SizeBytes int64

+ Text string

+ Type string

+ type AgentMCPToolResultEvent struct

+ Content []ContentBlock

+ IsError bool

+ MCPToolUseID string

+ Type string

+ type AgentMCPToolUseEvent struct

+ EvaluatedPermission *EvaluatedPermission

+ Input map[string]any

+ MCPServerName string

+ Name string

+ Type string

+ type AgentMessageEvent struct

+ Content []ContentBlock

+ Type string

+ type AgentModel struct

+ DefaultThinkingLevel string

+ DisplayName string

+ ID string

+ ThinkingLevels []string

+ type AgentPlatform interface

+ AckedSequence func(ctx context.Context, sessionID string) (int64, error)

+ AgentDelta func(executor *Executor, delta SessionEventDeltaParams)

+ AgentEvent func(ctx context.Context, executor *Executor, event AgentEventRecord) error

+ InteractionCanceled func(ctx context.Context, executor *Executor, cancel InteractionCancelParams) error

+ InteractionRequested func(ctx context.Context, executor *Executor, request InteractionRequestParams) (string, error)

+ type AgentThinkingEvent struct

+ Content []ContentBlock

+ Type string

+ type AgentToolResultEvent struct

+ Content []ContentBlock

+ IsError bool

+ ToolUseID string

+ Type string

+ type AgentToolUseEvent struct

+ EvaluatedPermission *EvaluatedPermission

+ Input map[string]any

+ Name string

+ Type string

+ type AgentTurn struct

+ func (t *AgentTurn) CancelInteraction(interactionID, reason string)

+ func (t *AgentTurn) Delta(eventID, eventType string, index int64, text string)

+ func (t *AgentTurn) Emit(event any) (string, error)

+ func (t *AgentTurn) EmitWithID(eventID string, event any) (string, error)

+ func (t *AgentTurn) Flush(ctx context.Context) error

+ func (t *AgentTurn) Inputs() <-chan TurnInputParams

+ func (t *AgentTurn) NewEventID() string

+ func (t *AgentTurn) Params() TurnStartParams

+ func (t *AgentTurn) RequestInteraction(ctx context.Context, params InteractionRequestParams) (InteractionResponseParams, error)

+ func (t *AgentTurn) SessionID() string

+ func (t *AgentTurn) TurnID() string

+ type AgentTurnConfig struct

+ Cwd string

+ Model string

+ PermissionMode string

+ System string

+ ThinkingLevel string

+ type ArtifactCapability struct

+ MaxBytes int64

+ Upload bool

+ type ArtifactRef struct

+ ArtifactID string

+ CreatedAt string

+ Digest string

+ MimeType string

+ Name string

+ SizeBytes int64

+ func NewArtifactRef(artifactID, name, mimeType string, sizeBytes int64) ArtifactRef

+ type Capabilities struct

+ Agent *AgentCapability

+ Artifacts *ArtifactCapability

+ Chrome bool

+ ComputerUse bool

+ Display json.RawMessage

+ Files *FilesCapability

+ MCP *MCPCapability

+ Process *ProcessCapability

+ Shell *ShellCapability

+ Skills *SkillsCapability

+ Terminal *TerminalCapability

+ Workspace *WorkspaceCapability

+ type Capability struct

+ Advertise func(*Capabilities)

+ Methods map[string]Handler

+ OnSessionEnd func(*CoreSession)

+ SessionScoped bool

+ func NewProcessCapability(core *Core, opts ProcessOptions) Capability

+ func NewSkillInstallCapability(install SkillInstaller) (Capability, error)

+ type ChannelTarget struct

+ Channel string

+ ServerKey string

+ SessionID string

+ type Client struct

+ func NewClient(options Options) (*Client, error)

+ func (c *Client) ActiveSessions() []string

+ func (c *Client) Call(ctx context.Context, method string, params any, result any) error

+ func (c *Client) ConnectionID() string

+ func (c *Client) Done() <-chan struct{}

+ func (c *Client) Err() error

+ func (c *Client) ExecutorID() string

+ func (c *Client) Notify(ctx context.Context, method string, params any) error

+ func (c *Client) OnDrain(handler DrainHandler)

+ func (c *Client) OnNotification(method string, handler func(json.RawMessage))

+ func (c *Client) OnRequest(method string, handler func(context.Context, json.RawMessage) (any, error))

+ func (c *Client) OnSessionAssign(handler SessionAssignHandler)

+ func (c *Client) OnSessionStop(handler SessionStopHandler)

+ func (c *Client) OnToolCall(handler ToolCallHandler)

+ func (c *Client) OnToolCallAccept(accept func(ToolCallParams) error)

+ func (c *Client) OpenMCPChannel(ctx context.Context, sessionID, serverKey string) (*MCPChannel, error)

+ func (c *Client) ReportToolResult(ctx context.Context, params ToolResultParams) (Ack, error)

+ func (c *Client) ServeAgent(handler AgentHandler, capability AgentCapability)

+ func (c *Client) SessionEnded(ctx context.Context, params SessionEndedParams) (Ack, error)

+ func (c *Client) SessionReady(ctx context.Context, params SessionReadyParams) (Ack, error)

+ func (c *Client) Start(ctx context.Context) (ExecutorRegisterResult, error)

+ func (c *Client) State() ConnectionState

+ func (c *Client) Stop(ctx context.Context, reason string) error

+ func (c *Client) UploadArtifact(ctx context.Context, sessionID, name, mimeType string, content []byte) (ArtifactRef, error)

+ type CloseError struct

+ Code int

+ Reason string

+ func (e *CloseError) Error() string

+ type Conn interface

+ Close func(code int, reason string) error

+ Read func(ctx context.Context) ([]byte, error)

+ Subprotocol func() string

+ Write func(ctx context.Context, frame []byte) error

+ func NewWebSocketConn(ws *websocket.Conn) Conn

+ type ConnectionState string

+ type ContentBlock struct

+ ArtifactID string

+ Data string

+ MimeType string

+ Text string

+ Type string

+ URL string

+ func NewArtifactContentBlock(ref ArtifactRef) ContentBlock

+ type Core struct

+ func NewCore(opts CoreOptions) (*Core, error)

+ func (c *Core) Attach(brain string, client *Client) error

+ func (c *Core) Capabilities() Capabilities

+ func (c *Core) Close()

+ func (c *Core) Env(explicit map[string]string) ([]string, error)

+ func (c *Core) Register(capability Capability) error

+ type CoreOptions struct

+ BashTimeout time.Duration

+ DenyEnv func(name string) bool

+ EndAfterToolCall func(SessionAssignParams) bool

+ Env map[string]string

+ InlineResultBytes int

+ MaxMCPServersPerSession int

+ MaxOutputBytes int

+ MaxSessions int

+ MaxSessionsPerBrain int

+ OnLog func(LogEvent)

+ RunAs *RunAs

+ UploadArtifacts bool

+ WorkRoot string

+ Workspace func(brain, sessionID string) string

+ type CoreSession struct

+ func (s *CoreSession) Assignment() SessionAssignParams

+ func (s *CoreSession) Brain() string

+ func (s *CoreSession) Client() *Client

+ func (s *CoreSession) Context() context.Context

+ func (s *CoreSession) ID() string

+ func (s *CoreSession) ResolveCwd(cwd string) (string, error)

+ func (s *CoreSession) Value(key any, create func() any) any

+ func (s *CoreSession) Workspace() string

+ type Cursors struct

+ Stderr int64

+ Stdout int64

+ type Dialer func(ctx context.Context, token ExecutorTokenResponse, protocol string, ...) (Conn, error)

+ func InProcessDialer(h *Harness, principal Principal) Dialer

+ func ListenNamedPipe(name, token string) (Dialer, func() error, error)

+ func ListenUnixSocket(path, token string) (Dialer, func() error, error)

+ func NamedPipeDialer(name string) Dialer

+ func UnixSocketDialer(path string) Dialer

+ func WebSocketDialer(httpClient *http.Client) Dialer

+ type DisplayCapability struct

+ Desktop bool

+ RFB bool

+ type DrainHandler func(ctx context.Context, params ExecutorDrainParams) (ExecutorDrainResult, error)

+ type EvaluatedPermission struct

+ Type string

+ type Executor struct

+ func (e *Executor) AgentCapability() (*AgentCapability, error)

+ func (e *Executor) AssignSession(ctx context.Context, params SessionAssignParams) (*Session, error)

+ func (e *Executor) Call(ctx context.Context, method string, params, out any) error

+ func (e *Executor) CancelTurn(ctx context.Context, params TurnCancelParams) (TurnCancelResult, error)

+ func (e *Executor) Capabilities(out any) error

+ func (e *Executor) CloseAgentSession(ctx context.Context, params SessionCloseParams) (SessionCloseResult, error)

+ func (e *Executor) Drain(ctx context.Context, reason string) (ExecutorDrainResult, error)

+ func (e *Executor) ID() string

+ func (e *Executor) Info() ExecutorInfo

+ func (e *Executor) Protocol() string

+ func (e *Executor) RespondInteraction(ctx context.Context, params InteractionResponseParams) (InteractionResponseResult, error)

+ func (e *Executor) SendTurnInput(ctx context.Context, params TurnInputParams) (Ack, error)

+ func (e *Executor) Sessions() []*Session

+ func (e *Executor) StartTurn(ctx context.Context, params TurnStartParams) (TurnStartResult, error)

+ type ExecutorCapabilitiesUpdateParams struct

+ Capabilities Capabilities

+ type ExecutorCloseParams struct

+ Reason string

+ type ExecutorDrainParams struct

+ DeadlineMS int64

+ Reason string

+ type ExecutorDrainResult struct

+ Accepted bool

+ ActiveSessions []string

+ type ExecutorHeartbeatParams struct

+ ActiveSessions []string

+ ConnectionID string

+ Load *ExecutorLoad

+ type ExecutorHeartbeatResult struct

+ Drain bool

+ LeaseTTLMS int64

+ ServerTime string

+ func SendExecutorHeartbeat(ctx context.Context, rpc RPC, params ExecutorHeartbeatParams) (ExecutorHeartbeatResult, error)

+ type ExecutorInfo struct

+ Arch string

+ Name string

+ OS string

+ Version string

+ type ExecutorLoad struct

+ CPUPercent float64

+ MemoryPercent float64

+ type ExecutorRegisterParams struct

+ Capabilities Capabilities

+ EnvironmentID string

+ Executor ExecutorInfo

+ Protocol string

+ Resume *ExecutorResume

+ type ExecutorRegisterResult struct

+ ConnectionID string

+ Drain bool

+ ExecutorID string

+ HeartbeatIntervalMS int64

+ LeaseTTLMS int64

+ Limits *Limits

+ MaxControlFrameBytes int64

+ MaxMCPFrameBytes int64

+ Protocol string

+ ServerTime string

+ func SendExecutorRegister(ctx context.Context, rpc RPC, params ExecutorRegisterParams) (ExecutorRegisterResult, error)

+ type ExecutorResume struct

+ ActiveSessions []string

+ ExecutorID string

+ LastConnectionID string

+ type ExecutorTokenRefreshParams struct

+ Token string

+ type ExecutorTokenRefreshResult struct

+ ExpiresAt string

+ func SendExecutorTokenRefresh(ctx context.Context, rpc RPC, params ExecutorTokenRefreshParams) (ExecutorTokenRefreshResult, error)

+ type ExecutorTokenRequest struct

+ EnvironmentID string

+ Executor ExecutorInfo

+ type ExecutorTokenResponse struct

+ ChannelScope []string

+ ExecutorID string

+ ExpiresIn int64

+ Token string

+ WSURL string

+ type FileTransferError struct

+ Code string

+ CurrentDigest string

+ Message string

+ type FileTransferResult struct

+ Digest string

+ Error *FileTransferError

+ Path string

+ type FileTransferer interface

+ TransferFile func(ctx context.Context, processID string, transfer ProcessFileTransfer) (FileTransferResult, error)

+ type FilesCapability struct

+ Enabled bool

+ ReadRoots []string

+ WriteRoots []string

+ type GitCredentialGranter interface

+ Grant func(processID string, env []string) ([]string, func(), error)

+ type Handler func(ctx context.Context, req Request) (any, error)

+ type Harness struct

+ func NewHarness(opts HarnessOptions) *Harness

+ func (h *Harness) DialExecutor(ctx context.Context, path, token string) error

+ func (h *Harness) Executors() []*Executor

+ func (h *Harness) ServeConn(transport Conn, principal Principal)

+ func (h *Harness) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (h *Harness) WaitExecutor(ctx context.Context) (*Executor, error)

+ type HarnessMCPChannel struct

+ func (m *HarnessMCPChannel) Close() error

+ func (m *HarnessMCPChannel) Read(ctx context.Context) ([]byte, error)

+ func (m *HarnessMCPChannel) Write(ctx context.Context, frame []byte) error

+ type HarnessOptions struct

+ Agent AgentPlatform

+ Authenticate func(r *http.Request) (Principal, error)

+ HeartbeatInterval time.Duration

+ LeaseTTL time.Duration

+ OnExecutor func(*Executor)

+ OnLog func(LogEvent)

+ OnProcessStatus func(executor *Executor, params ProcessStatusParams)

+ OnSessionEvent func(ctx context.Context, executor *Executor, params SessionEventParams) (SessionEventResult, error)

+ OnSessionStatus func(executor *Executor, params SessionStatusParams)

+ OnToolProgress func(executor *Executor, params ToolProgressParams)

+ Protocols []string

+ RequestTimeout time.Duration

+ type InteractionCancelParams struct

+ InteractionID string

+ Reason string

+ SessionID string

+ type InteractionQuestion struct

+ AllowFreeText bool

+ MultiSelect bool

+ Options []InteractionQuestionOption

+ Prompt string

+ type InteractionQuestionOption struct

+ ID string

+ Label string

+ type InteractionRequestParams struct

+ ExpiresAt string

+ InteractionID string

+ Kind string

+ Question *InteractionQuestion

+ Scopes []string

+ SessionID string

+ ToolInput map[string]any

+ ToolName string

+ ToolUseID string

+ TurnID string

+ type InteractionRequestResult struct

+ Accepted bool

+ PlatformInteractionID string

+ func SendInteractionRequest(ctx context.Context, rpc RPC, params InteractionRequestParams) (InteractionRequestResult, error)

+ type InteractionResponder struct

+ ActorID string

+ Surface string

+ type InteractionResponseParams struct

+ Answers []string

+ DenyMessage string

+ InteractionID string

+ Outcome string

+ Responder *InteractionResponder

+ Scope string

+ SessionID string

+ type InteractionResponseResult struct

+ Accepted bool

+ type JSONRPCError struct

+ Code int

+ Data *JSONRPCErrorData

+ Message string

+ type JSONRPCErrorData struct

+ Capability string

+ Detail string

+ ExpectedSequence int64

+ Reason string

+ Retryable bool

+ TerminalCode string

+ type JSONRPCErrorResponse struct

+ Error JSONRPCError

+ ID string

+ JSONRPC string

+ type JSONRPCNotification struct

+ JSONRPC string

+ Method string

+ Params json.RawMessage

+ type JSONRPCRequest struct

+ ID string

+ JSONRPC string

+ Method string

+ Params json.RawMessage

+ type JSONRPCSuccessResponse struct

+ ID string

+ JSONRPC string

+ Result json.RawMessage

+ type Lease struct

+ FencingToken int64

+ Token string

+ type Limits struct

+ MaxArtifactBytes int64

+ MaxConcurrentProcessReads int

+ MaxInflightRequests int

+ MaxProcessReadBytes int

+ MaxProcessWriteBytes int

+ MaxProcessesPerSession int

+ type LogEvent struct

+ Err error

+ Level LogLevel

+ Message string

+ type LogLevel string

+ const LogDebug

+ const LogError

+ const LogInfo

+ const LogWarn

+ type MCPCapability struct

+ HTTP bool

+ MaxServers int

+ SecretEnv bool

+ Stdio bool

+ type MCPChannel struct

+ func (m *MCPChannel) Close() error

+ func (m *MCPChannel) Read(ctx context.Context) ([]byte, error)

+ func (m *MCPChannel) Write(ctx context.Context, payload []byte) error

+ type MCPContentBlock struct

+ Data string

+ MimeType string

+ Resource any

+ Text string

+ Type string

+ type MCPImplementation struct

+ Name string

+ Version string

+ type MCPInitializeParams struct

+ Capabilities map[string]any

+ ClientInfo MCPImplementation

+ ProtocolVersion string

+ type MCPInitializeResult struct

+ Capabilities map[string]any

+ ProtocolVersion string

+ ServerInfo MCPImplementation

+ type MCPJSONRPCError struct

+ Code int64

+ Data any

+ Message string

+ type MCPJSONRPCErrorResponse struct

+ Error MCPJSONRPCError

+ ID json.RawMessage

+ JSONRPC string

+ type MCPJSONRPCNotification struct

+ JSONRPC string

+ Method string

+ Params map[string]any

+ type MCPJSONRPCRequest struct

+ ID json.RawMessage

+ JSONRPC string

+ Method string

+ Params map[string]any

+ type MCPJSONRPCSuccessResponse struct

+ ID json.RawMessage

+ JSONRPC string

+ Result any

+ type MCPProgressParams struct

+ Progress float64

+ ProgressToken json.RawMessage

+ Total float64

+ type MCPServerConfig struct

+ ConnectionOrigin string

+ ServerKey string

+ Transport MCPServerTransport

+ type MCPServerTransport struct

+ Args []string

+ Command string

+ CommandSHA256 string

+ Cwd string

+ Env map[string]string

+ SecretEnv map[string]string

+ TimeoutMS int64

+ Type string

+ URL string

+ type MCPTool struct

+ Description string

+ InputSchema map[string]any

+ Name string

+ type MCPToolsCallParams struct

+ Arguments map[string]any

+ Name string

+ type MCPToolsCallResult struct

+ Content []MCPContentBlock

+ IsError bool

+ StructuredContent any

+ type MCPToolsListParams struct

+ Cursor string

+ type MCPToolsListResult struct

+ NextCursor *string

+ Tools []MCPTool

+ type MethodDirection string

+ const DirectionBidirectional

+ const DirectionExecutorToHarness

+ const DirectionHarnessToExecutor

+ type MethodSpec struct

+ Capability string

+ Direction MethodDirection

+ IdempotentBy string

+ Name string

+ Notification bool

+ Since string

+ type Options struct

+ BaseURL string

+ Capabilities Capabilities

+ Dial Dialer

+ EnvironmentID string

+ EnvironmentKey string

+ Executor ExecutorInfo

+ HTTPClient *http.Client

+ HeartbeatInterval time.Duration

+ HeartbeatLoad func() *ExecutorLoad

+ MaxReconnectAttempts int

+ OnLog func(LogEvent)

+ OnToolResultLost func(params ToolResultParams, err error)

+ Protocol string

+ Random func() float64

+ ReconnectBaseDelay time.Duration

+ ReconnectMaxDelay time.Duration

+ RequestTimeout time.Duration

+ TokenSource func(ctx context.Context) (ExecutorTokenResponse, error)

+ ToolResultRetryAttempts int

+ ToolResultRetryBaseDelay time.Duration

+ WSURL string

+ type PackageInstallCommand struct

+ Argv []string

+ Dir string

+ Env []string

+ Privileged bool

+ type PackageInstaller interface

+ PackageInstallCommand func(processID string, install ProcessPackageInstall) (PackageInstallCommand, error)

+ type Principal struct

+ ExecutorID string

+ type ProcessCapability struct

+ BufferBytes int

+ Enabled bool

+ FileTransfer bool

+ GitCredentials bool

+ MaxProcesses int

+ PTY bool

+ PackageInstall bool

+ type ProcessFileTransfer struct

+ Direction string

+ LocalPath string

+ type ProcessListParams struct

+ SessionID string

+ type ProcessListResult struct

+ Processes []ProcessState

+ type ProcessOptions struct

+ Env map[string]string

+ FileTransfer FileTransferer

+ GitCredentials GitCredentialGranter

+ PackageInstaller PackageInstaller

+ type ProcessPackageInstall struct

+ Manager string

+ Packages []string

+ type ProcessReadParams struct

+ Cursor int64

+ MaxBytes int

+ ProcessID string

+ SessionID string

+ Stream string

+ WaitMS int64

+ type ProcessReadResult struct

+ Data string

+ EOF bool

+ EarliestCursor int64

+ EndedAt string

+ ExitCode *int

+ ExitSignal *string

+ FileTransfer *FileTransferResult

+ FromCursor int64

+ Gap bool

+ NextCursor int64

+ ProcessID string

+ Reason string

+ State string

+ Stream string

+ Truncated bool

+ type ProcessSignalParams struct

+ GraceMS *int64

+ ProcessID string

+ SessionID string

+ type ProcessStartParams struct

+ Argv []string

+ Cwd string

+ Env map[string]string

+ FileTransfer *ProcessFileTransfer

+ GitCredentials bool

+ IOMode string

+ Metadata map[string]string

+ PackageInstall *ProcessPackageInstall

+ ProcessID string

+ SessionID string

+ Stderr string

+ Stdin string

+ TimeoutMS int64

+ WaitMS int64

+ type ProcessState struct

+ Accepted bool

+ Cursors Cursors

+ EndedAt string

+ ExitCode *int

+ ExitSignal *string

+ FileTransfer *FileTransferResult

+ PID int

+ ProcessID string

+ Reason string

+ StartedAt string

+ State string

+ Stderr string

+ type ProcessStatusParams struct

+ EndedAt string

+ ExitCode *int

+ ExitSignal *string

+ ObservedAt string

+ ProcessID string

+ Reason string

+ SessionID string

+ State string

+ type ProcessWriteParams struct

+ CloseStdin bool

+ Data string

+ ProcessID string

+ SessionID string

+ type ProcessWriteResult struct

+ Accepted bool

+ type RPC interface

+ Call func(ctx context.Context, method string, params any, result any) error

+ Notify func(ctx context.Context, method string, params any) error

+ type RPCError struct

+ Code int

+ Data *JSONRPCErrorData

+ Message string

+ func (e *RPCError) Error() string

+ type Request struct

+ Brain string

+ Client *Client

+ ID string

+ Method string

+ Params json.RawMessage

+ Session *CoreSession

+ type RunAs struct

+ GID uint32

+ Groups []uint32

+ Home string

+ UID uint32

+ User string

+ type Session struct

+ func (s *Session) CallTool(ctx context.Context, params ToolCallParams) (ToolResultParams, error)

+ func (s *Session) CancelTool(ctx context.Context, toolCallID, reason string) (bool, error)

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) EndReason() string

+ func (s *Session) Executor() *Executor

+ func (s *Session) ID() string

+ func (s *Session) MCP(ctx context.Context, serverKey string) (*HarnessMCPChannel, error)

+ func (s *Session) Ready(ctx context.Context) error

+ func (s *Session) Stop(ctx context.Context, reason string) error

+ func (s *Session) WorkID() string

+ type SessionAssignHandler func(ctx context.Context, params SessionAssignParams) (SessionAssignResult, error)

+ type SessionAssignParams struct

+ AgentID string

+ DeadlineMS int64

+ EnvironmentID string

+ Lease Lease

+ MCPServers []MCPServerConfig

+ Metadata map[string]string

+ Resources []json.RawMessage

+ SessionID string

+ WorkID string

+ type SessionAssignResult struct

+ Accepted bool

+ SessionID string

+ type SessionCloseParams struct

+ Reason string

+ SessionID string

+ type SessionCloseResult struct

+ Closed bool

+ type SessionEndedParams struct

+ Reason string

+ SessionID string

+ type SessionErrorEvent struct

+ Error AgentErrorInfo

+ Type string

+ type SessionEvent struct

+ Content []ContentBlock

+ IsError bool

+ ToolUseID string

+ Type string

+ type SessionEventDeltaParams struct

+ EventID string

+ EventType string

+ Index int64

+ SessionID string

+ Text string

+ TurnID string

+ type SessionEventParams struct

+ Event json.RawMessage

+ EventID string

+ Sequence int64

+ SessionID string

+ TurnID string

+ type SessionEventResult struct

+ Accepted bool

+ AckedSequence int64

+ EventID string

+ func SendSessionEvent(ctx context.Context, rpc RPC, params SessionEventParams) (SessionEventResult, error)

+ type SessionMemoryResource struct

+ MemoryStoreID string

+ MountPath string

+ Type string

+ type SessionReadyParams struct

+ LeaseToken string

+ SessionID string

+ WorkID string

+ type SessionStatusIdleEvent struct

+ StopReason StopReason

+ TurnOutcome string

+ Type string

+ type SessionStatusParams struct

+ Detail string

+ SessionID string

+ Status string

+ type SessionStatusRunningEvent struct

+ Type string

+ type SessionStopHandler func(ctx context.Context, params SessionStopParams) (SessionStopResult, error)

+ type SessionStopParams struct

+ DeadlineMS int64

+ Reason string

+ SessionID string

+ type SessionStopResult struct

+ Stopped bool

+ type ShellCapability struct

+ Enabled bool

+ type SkillInstallParams struct

+ Digest string

+ DownloadExpiresAt int64

+ DownloadToken string

+ MachineID string

+ RevisionID string

+ SkillID string

+ type SkillInstallResult struct

+ Error string

+ ErrorCode string

+ State string

+ type SkillInstaller func(ctx context.Context, params SkillInstallParams) SkillInstallResult

+ type SkillsCapability struct

+ Install bool

+ type StopReason struct

+ Type string

+ type TerminalAttachParams struct

+ AckSeq int64

+ CanWrite bool

+ Epoch int64

+ FromSeq int64

+ Host TerminalHost

+ StreamID string

+ TerminalID string

+ type TerminalAttachResult struct

+ Accepted bool

+ WriterEpoch uint64

+ type TerminalCapability struct

+ Enabled bool

+ Kinds []string

+ MaxSessions int

+ type TerminalCloseParams struct

+ Reason string

+ TerminalID string

+ type TerminalCloseResult struct

+ Closed bool

+ ExitCode *int

+ type TerminalErrorData struct

+ TerminalCode string

+ type TerminalHost struct

+ Ticket string

+ URL string

+ type TerminalOpenParams struct

+ Argv []string

+ Cols uint16

+ Cwd string

+ Env map[string]string

+ Kind string

+ Rows uint16

+ Shell string

+ TerminalID string

+ type TerminalOpenResult struct

+ Cols uint16

+ CreatedAt string

+ EarliestSeq int64

+ Epoch int64

+ LatestSeq int64

+ PID int

+ Rows uint16

+ TerminalID string

+ type ToolCallHandler func(ctx context.Context, params ToolCallParams) (ToolResultParams, error)

+ type ToolCallParams struct

+ DeadlineMS int64

+ Input json.RawMessage

+ Permission *ToolPermission

+ SessionID string

+ Tool string

+ ToolCallID string

+ func (p ToolCallParams) DecodeInput() (ToolInput, error)

+ type ToolCancelParams struct

+ Reason string

+ SessionID string

+ ToolCallID string

+ type ToolCancelResult struct

+ Canceled bool

+ type ToolInput struct

+ Action string

+ Command string

+ Content string

+ Cwd string

+ Display string

+ Env map[string]string

+ Glob string

+ Limit int64

+ NewString string

+ Offset int64

+ OldString string

+ Path string

+ Pattern string

+ TimeoutMS int64

+ type ToolPermission struct

+ Mode string

+ type ToolProgressParams struct

+ Message string

+ SessionID string

+ ToolCallID string

+ type ToolResultParams struct

+ Artifacts []ArtifactRef

+ Content []ContentBlock

+ DurationMS int64

+ IsError bool

+ Outcome string

+ SessionID string

+ ToolCallID string

+ type TurnCancelParams struct

+ Reason string

+ SessionID string

+ TurnID string

+ type TurnCancelResult struct

+ Canceled bool

+ type TurnInputParams struct

+ Input []AgentInputBlock

+ InputID string

+ SessionID string

+ TurnID string

+ type TurnStartParams struct

+ Config *AgentTurnConfig

+ DeadlineMS int64

+ ExecutorSessionRef string

+ Input []AgentInputBlock

+ InputID string

+ Metadata map[string]string

+ SessionID string

+ TurnID string

+ type TurnStartResult struct

+ Accepted bool

+ Effective AgentTurnConfig

+ ExecutorSessionRef string

+ Resumed bool

+ TurnID string

+ type WorkspaceBackupParams struct

+ BackupID string

+ Exclude []string

+ Paths []string

+ SkipIfFingerprint string

+ type WorkspaceBackupResult struct

+ Digest string

+ Entries int

+ Error string

+ Fingerprint string

+ SizeBytes int64

+ Skipped int

+ State string

+ type WorkspaceCapability struct

+ Backup bool

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