Rulvar API reference / @rulvar/executor / ToolEffectRecord
Interface: ToolEffectRecord
Defined in: packages/executor/src/spi.ts:96
One dispatch's side-effect facts, for the ledger.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
argsHash | string | sha256 of the canonical arguments: correlates without storing them. | ToolEffectIntent.argsHash | packages/executor/src/spi.ts:69 |
attemptId? | string | Unique id of this dispatch ATTEMPT (RV501): the reference executors mint one before the intent row is written and copy it verbatim onto the same attempt's outcome row, so the two phases pair exactly. Optional because rows written before v1.96.0 (and third-party ledgers) may omit it; loadEffectLedger then falls back to the legacy (idempotencyKey, startedAt) join. | ToolEffectIntent.attemptId | packages/executor/src/spi.ts:92 |
cwd? | string | The acquired worktree the tool ran in (RV4914), present exactly when the request carried one: the child's working directory under the subprocess executor, the host directory bind mounted at workMount under the container executor. Absent otherwise, so rows written without one keep their historical shape. | ToolEffectIntent.cwd | packages/executor/src/spi.ts:80 |
durationMs | number | - | - | packages/executor/src/spi.ts:97 |
executor | IsolatedExecutorTag | - | ToolEffectIntent.executor | packages/executor/src/spi.ts:70 |
exitCode | number | null | Child exit code, or null when terminated by a signal. | - | packages/executor/src/spi.ts:100 |
idempotencyKey | string | The stable per-call idempotency key (createEngine derives it). | ToolEffectIntent.idempotencyKey | packages/executor/src/spi.ts:64 |
outcome | "timeout" | "error" | "ok" | - | - | packages/executor/src/spi.ts:98 |
runId | string | - | ToolEffectIntent.runId | packages/executor/src/spi.ts:65 |
signal | string | null | The terminating signal, when any. | - | packages/executor/src/spi.ts:102 |
spanId | string | - | ToolEffectIntent.spanId | packages/executor/src/spi.ts:66 |
startedAt | number | - | ToolEffectIntent.startedAt | packages/executor/src/spi.ts:83 |
tool | string | - | ToolEffectIntent.tool | packages/executor/src/spi.ts:67 |
workdir | string | The ephemeral working directory the dispatch runs in. | ToolEffectIntent.workdir | packages/executor/src/spi.ts:72 |
workMount? | string | Under the container executor with a cwd: the container path it is mounted at (RV4914). | ToolEffectIntent.workMount | packages/executor/src/spi.ts:82 |