Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.microsandbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

Events are coming soon and not yet available in the current SDK.
See Events for usage examples and guest-side emitting. The planned Go surface mirrors the Rust and TypeScript references, using context.Context for calls and a subscription handle for listeners.

Planned Sandbox methods


Emit()

func (s *Sandbox) Emit(ctx context.Context, eventName string, data any) error
Send a named event with a JSON-serializable payload into the guest. Any process listening on the agent socket (/run/agent.sock) receives it.

OnEvent()

func (s *Sandbox) OnEvent(eventName string, callback func(EventData)) (*Subscription, error)
Subscribe to named events emitted by guest processes. The callback fires each time the guest sends a matching event through /run/agent.sock.

Planned types

type EventData struct {
    Event string
    Data  any
}