Encode, decode, and patch

Operational transforms run on an initialized Ecp instance. They do not emit full run lifecycle hooks the way run does.

Result shape

Encode / decode / patch results use protocol schemas with success, .result, validation, and diagnostics — not legacy .content / .document fields.

Encode

await ecp
  .encode(source)
  .uses("@executioncontrolprotocol/format-toon")
  .to("@executioncontrolprotocol.workflow")
  .with({ headers: false })
  .process()

Omit .uses(...) for canonical JSON passthrough.

Format	How
JSON	Canonical; default / no format extension
Fluent	Core built-in encode (`--format fluent` / format-fluent id in core)
TOON	`@executioncontrolprotocol/format-toon` package

CLI:

ecp encode workflow.json --format toon --env environment.ts -o workflow.toon
ecp encode workflow.json --format fluent --env environment.ts -o workflow.generated.ts

Decode

await ecp
  .decode(input)
  .uses("@executioncontrolprotocol/format-toon")
  .to("@executioncontrolprotocol.patch")
  .process()

Notes:

Decode input field is input in extension payloads.
Fluent decode is not supported — use ecp compile for TypeScript → JSON.

ecp decode workflow.toon --format toon --env environment.ts -o workflow.json
ecp compile workflow.ts -o workflow.json

Patch

await ecp.patch(manifest).with(patchDocOrShorthand).process()

Patch paths target steps by id: steps[<stepId>].field. Workflow builders assign unique step ids so patches stay unambiguous. Target schema: @executioncontrolprotocol.patch (and @executioncontrolprotocol.patch.result for outcomes).

Getting started

Learn

Build

Alternatives

AI tools

Reference

Encode, decode, and patch

Encode, decode, and patch

Result shape

Encode

Decode

Patch

Next steps

​Encode, decode, and patch

​Result shape

​Encode

​Decode

​Patch

​Next steps

Encode, decode, and patch

Result shape

Encode

Decode

Patch

Next steps