On this page
Run a remote worker that connects to a brain over WebSocket and executes the tool calls routed to it, either as a native process or inside a Docker container.
#orxtra worker
Manage remote worker processes that execute tool calls for the brain.
#worker connect
Run a native worker process that connects to a brain over WebSocket, authenticates with --key, registers the tool capabilities it can serve, and then executes the tool calls the brain routes to it against the project root given by --root. Runs until the connection closes or the process is stopped.
Effect: mutating
#Flags
| Name | Short | Type | Default | Env | Description |
|---|---|---|---|---|---|
--brain | str | WebSocket URL of the brain to connect to (e.g. ws://host:port). | |||
--root | str | Filesystem path to the project root directory for tool execution. | |||
--key | str | API key used for authenticating with the brain server. |
#worker docker
Run a worker inside a Docker container built from --image, connected to the brain at --brain and executing tool calls against the project root given by --root. Authenticates with --key exactly as the native worker does; the container is what isolates tool execution from the host filesystem.
Effect: mutating
#Flags
| Name | Short | Type | Default | Env | Description |
|---|---|---|---|---|---|
--brain | str | WebSocket URL of the brain to connect to (e.g. ws://host:port). | |||
--image | str | Docker image name to use for the worker container. | |||
--root | str | Filesystem path to the project root directory for tool execution. | |||
--key | str | API key used for authenticating with the brain server. |