@usine/core/worker
Type Aliases
Section titled “Type Aliases”GatewayDomain
Section titled “GatewayDomain”GatewayDomain = typeof
GatewayDomain.Type
The private DNS domain of the Gateway in front of a Worker’s machine
(ADR 0027). The
machine resolves git.<domain> for GitHub, llm.<domain> for the LLM
providers, and <domain> itself for the forward proxy.
GatewayLlmProvider
Section titled “GatewayLlmProvider”GatewayLlmProvider = typeof
GatewayLlmProvider.Type
An LLM provider whose credential the Gateway holds, so the harness that
uses it calls the Gateway with the Attempt’s caller token instead of a
login on the machine: anthropic for Claude Code.
SshDestination
Section titled “SshDestination”SshDestination = typeof
SshDestination.Type
Where the local ssh client connects: a host name, an address, or a Host
alias from the operator’s SSH configuration, optionally prefixed by a user.
It is passed to ssh as one argument, so a value that could read as an
option (-oProxyCommand=...) cannot be constructed.
SshIdentityFile
Section titled “SshIdentityFile”SshIdentityFile = typeof
SshIdentityFile.Type
The private key file the local ssh client authenticates with, absolute
or relative to the orchestrator user’s home (~/.ssh/usine_worker).
SshPort
Section titled “SshPort”SshPort = typeof
SshPort.Type
The TCP port the SSH server of a Worker’s machine listens on.
WorkerKind
Section titled “WorkerKind”WorkerKind = typeof
WorkerKind.Type
WorkerName
Section titled “WorkerName”WorkerName = typeof
WorkerName.Type
Kebab-case name of a configured Worker.
WorkerRoot
Section titled “WorkerRoot”WorkerRoot = typeof
WorkerRoot.Type
The absolute directory on a Worker’s machine under which every Worker using
it keeps its cached clones, Attempt checkouts, and Attempt credentials, at
<root>/workers/<worker>. Printable characters only, no trailing slash.
Variables
Section titled “Variables”GatewayDomain
Section titled “GatewayDomain”
constGatewayDomain:Schema.brand<Schema.String,"GatewayDomain">
The private DNS domain of the Gateway in front of a Worker’s machine
(ADR 0027). The
machine resolves git.<domain> for GitHub, llm.<domain> for the LLM
providers, and <domain> itself for the forward proxy.
GatewayLlmProvider
Section titled “GatewayLlmProvider”
constGatewayLlmProvider:Schema.Literals<readonly ["anthropic"]>
An LLM provider whose credential the Gateway holds, so the harness that
uses it calls the Gateway with the Attempt’s caller token instead of a
login on the machine: anthropic for Claude Code.
SshDestination
Section titled “SshDestination”
constSshDestination:Schema.brand<Schema.String,"SshDestination">
Where the local ssh client connects: a host name, an address, or a Host
alias from the operator’s SSH configuration, optionally prefixed by a user.
It is passed to ssh as one argument, so a value that could read as an
option (-oProxyCommand=...) cannot be constructed.
SshIdentityFile
Section titled “SshIdentityFile”
constSshIdentityFile:Schema.brand<Schema.String,"SshIdentityFile">
The private key file the local ssh client authenticates with, absolute
or relative to the orchestrator user’s home (~/.ssh/usine_worker).
SshPort
Section titled “SshPort”
constSshPort:Schema.brand<Schema.Int,"SshPort">
The TCP port the SSH server of a Worker’s machine listens on.
WORKER_KINDS
Section titled “WORKER_KINDS”
constWORKER_KINDS: readonly ["local","exe.dev","ssh"]
The Worker kinds the engine has an adapter for.
WorkerKind
Section titled “WorkerKind”
constWorkerKind:Schema.Literals<readonly ["local","exe.dev","ssh"]>
WorkerName
Section titled “WorkerName”
constWorkerName:Schema.brand<Schema.String,"WorkerName">
Kebab-case name of a configured Worker.
WorkerRoot
Section titled “WorkerRoot”
constWorkerRoot:Schema.brand<Schema.String,"WorkerRoot">
The absolute directory on a Worker’s machine under which every Worker using
it keeps its cached clones, Attempt checkouts, and Attempt credentials, at
<root>/workers/<worker>. Printable characters only, no trailing slash.