@usine/config/factory

Classes

ExeDevWorker

An exe.dev VM named after the Worker, with the number of Attempts it may run at the same time.

Extends

• Schema.Class

Constructors

Constructor

new ExeDevWorker(…args): ExeDevWorker

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ExeDevWorker

Properties

kind

readonly kind: "exe.dev"

maxConcurrentAttempts

readonly maxConcurrentAttempts: number

name

readonly name: string & Brand<"WorkerName">

---

LocalWorker

The orchestrator’s own machine as a Worker, with the number of Attempts it may run at the same time.

Extends

• Schema.Class

Constructors

Constructor

new LocalWorker(…args): LocalWorker

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

LocalWorker

Properties

kind

readonly kind: "local"

maxConcurrentAttempts

readonly maxConcurrentAttempts: number

name

readonly name: string & Brand<"WorkerName">

---

ManagedRepo

A repository the factory manages, with its selector tags and configured Board lanes.

Extends

• Schema.Class

Constructors

Constructor

new ManagedRepo(…args): ManagedRepo

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ManagedRepo

Properties

lanes

readonly lanes: readonly Lane[]

name

readonly name: string & Brand<"RepositoryName">

tags

readonly tags: readonly (string & Brand<"RegistryTag">)[]

---

Settings

Factory-wide polling, Attempt limits, and defaults for the coordinating parent.

Extends

• Schema.Class

Constructors

Constructor

new Settings(…args): Settings

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Settings

Properties

maxAttemptMinutes

readonly maxAttemptMinutes: Option<number>

Wall-clock ceiling per Attempt in minutes. Absent by default: the runaway guard’s timer is not armed.

maxAttemptTokens

readonly maxAttemptTokens: Option<number>

Consumed-token ceiling per Attempt across the parent and every child. Absent by default: the token guard is not armed.

maxChildren

readonly maxChildren: number & Brand<"ChildSessionBudget">

Total child sessions allowed over one Attempt’s lifetime, including sequential spawns; defaults to four.

parentEffort

readonly parentEffort: Option<"off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max">

Default parent reasoning effort; if neither Agent nor factory supplies one, the child’s effort applies.

parentModel

readonly parentModel: Option<string & Brand<"ModelId">>

Parent model used when the Agent has no override; an absent default leaves selection to Pi.

pollInterval

readonly pollInterval: number

Seconds between routine GitHub polling cycles; defaults to 60.

---

SshWorker

A Linux machine the orchestrator connects to over SSH, with the number of Attempts it may run at the same time. The orchestrator’s ssh client connects to destination, on port and with identityFile when given, and the Worker keeps its state under <root>/workers/<name> on the machine. A Worker behind a gateway has no GitHub token on its machine: the executor attaches each Attempt’s token to the Gateway instead.

Extends

• Schema.Class

Constructors

Constructor

new SshWorker(…args): SshWorker

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

SshWorker

Properties

destination

readonly destination: string & Brand<"SshDestination">

gateway

readonly gateway: Option<WorkerGateway>

identityFile

readonly identityFile: Option<string & Brand<"SshIdentityFile">>

kind

readonly kind: "ssh"

maxConcurrentAttempts

readonly maxConcurrentAttempts: number

name

readonly name: string & Brand<"WorkerName">

port

readonly port: Option<number & Brand<"SshPort">>

root

readonly root: string & Brand<"WorkerRoot">

---

UsineConfig

The factory’s repository registry, Worker capacity, labels, and operating defaults from usine.yaml.

Extends

• Schema.Class

Constructors

Constructor

new UsineConfig(…args): UsineConfig

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

UsineConfig

Properties

labels

readonly labels: readonly DeclaredLabel[]

operator

readonly operator: Option<string & Brand<"OperatorLogin">>

repos

readonly repos: readonly ManagedRepo[]

settings

readonly settings: Settings

version

readonly version: 1

webhooks

readonly webhooks: { mode: "off"; } | { mode: "deliveries"; } | { mode: "endpoint"; publicUrl: URL; }

workers

readonly workers: readonly (LocalWorker | ExeDevWorker | SshWorker)[]

---

WorkerGateway

The Gateway in front of an SSH Worker’s machine on a private network (ADR 0027). domain is the Gateway’s private DNS domain. adminUrl is its admin API as the orchestrator reaches it, usually a local forward through the SSH connection to the Gateway. The admin token is read at startup from the orchestrator’s environment variable adminTokenEnv, so it is never in the file. llmProviders names the providers whose credential the Gateway holds. A harness whose provider is not listed uses the operator’s login on the Worker and reaches the provider through the Gateway’s forward proxy; Codex always does.

Extends

• Schema.Class

Constructors

Constructor

new WorkerGateway(…args): WorkerGateway

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

WorkerGateway

Properties

adminTokenEnv

readonly adminTokenEnv: string & Brand<"EnvironmentVariableName">

adminUrl

readonly adminUrl: URL

domain

readonly domain: string & Brand<"GatewayDomain">

llmProviders

readonly llmProviders: readonly "anthropic"[]

Type Aliases

OperatorLogin

OperatorLogin = typeof OperatorLogin.Type

GitHub login identifying the human operator for this factory.

---

RegistryTag

RegistryTag = typeof RegistryTag.Type

A factory-defined repository grouping that Loops can select by tag.

---

Webhooks

Webhooks = typeof Webhooks.Type

How GitHub hints reach the factory to request earlier polling; routine polling remains the backstop.

---

Worker

Worker = typeof Worker.Type

A named place to execute Attempts; its kind selects the Worker adapter and the settings that adapter needs.

Variables

OperatorLogin

const OperatorLogin: Schema.brand<Schema.String, "OperatorLogin">

GitHub login identifying the human operator for this factory.

---

RegistryTag

const RegistryTag: Schema.brand<Schema.String, "RegistryTag">

A factory-defined repository grouping that Loops can select by tag.

---

Webhooks

const Webhooks: Schema.Union<readonly [Schema.Struct<{ mode: Schema.Literal<"off">; }>, Schema.Struct<{ mode: Schema.Literal<"deliveries">; }>, Schema.encodeKeys<Schema.Struct<{ mode: Schema.Literal<"endpoint">; publicUrl: Schema.URLFromString; }>, { publicUrl: "public_url"; }>]>

How GitHub hints reach the factory to request earlier polling; routine polling remains the backstop.

---

Worker

const Worker: Schema.Union<readonly [typeof LocalWorker, typeof ExeDevWorker, typeof SshWorker]>

A named place to execute Attempts; its kind selects the Worker adapter and the settings that adapter needs.