Chio/Docs

chio work

Run work commitments through the owner service: submit a command, read its view, collect the result, and export its evidence.

Reference chio@5f63e6e

On this page

All command families · Global flags

chio work

Run work commitments through the owner service.

Command synopsistext
chio work [OPTIONS] <COMMAND>
  • chio work init Initialize a private work state directory from a host profile.
  • chio work serve Serve the owner work service from a state directory until SIGINT or SIGTERM.
  • chio work prepare Prepare one owner artifact, such as a Select or an Agreement, from a chio.work.preparation.v1 document.
  • chio work fund Fund an agreement’s exclusive allocation on its configured rail and attach the funding reference to the commitment.
  • chio work submit Submit one work command under its caller-supplied command ID.
  • chio work inspect Read the work view for a handle, or for an original command or preparation ID.
  • chio work collect Reconcile finished work and record its results, with no second dispatch.
  • chio work export Export the signed records for a work commitment as an evidence package.

chio work init

Initialize a private work state directory from a host profile.

Command synopsistext
chio work init [OPTIONS] --config <CONFIG> --state <STATE>
  • --config <CONFIG> Host profile. Required.
  • --state <STATE> Private work state directory. Required.

chio work serve

Serve the owner work service from a state directory until SIGINT or SIGTERM.

Command synopsistext
chio work serve [OPTIONS] --state <STATE>
  • --state <STATE> Private work state directory. Required.

chio work prepare

Prepare one owner artifact, such as a Select or an Agreement, from a chio.work.preparation.v1 document.

Command synopsistext
chio work prepare [OPTIONS] --state <STATE> <PREPARATION>
  • <PREPARATION> Preparation document (chio.work.preparation.v1). Required.
  • --state <STATE> Private work state directory. Required.
Additional behavior

Prints the outcome: Prepared with the agreement digest, Pending while a counterparty signature is outstanding, or Refused with its reason.

chio work fund

Fund an agreement’s exclusive allocation on its configured rail and attach the funding reference to the commitment.

Command synopsistext
chio work fund [OPTIONS] --state <STATE> <PREPARATION_ID>
  • <PREPARATION_ID> Preparation ID printed by chio work prepare. Required.
  • --state <STATE> Private work state directory. Required.
Additional behavior

Prints the allocation ID. Funding the same preparation again returns the same allocation; it never funds twice.

chio work submit

Submit one work command under its caller-supplied command ID.

Command synopsistext
chio work submit [OPTIONS] --state <STATE> <COMMAND>
  • <COMMAND> Work command document (chio.work.command.v1). Required.
  • --state <STATE> Private work state directory. Required.
Additional behavior

Submitting the same command ID again returns the original outcome; the command is never dispatched twice.

chio work inspect

Read the work view for a handle, or for an original command or preparation ID.

Command synopsistext
chio work inspect [OPTIONS] --state <STATE> <ID>
  • <ID> Work handle, or the original command or preparation ID. Required.
  • --state <STATE> Private work state directory. Required.
  • --costs Add production, verification, and coordination cost, and the verification-to-production ratio, from the receipts both kernels signed.
Additional behavior

The view reports six dimensions: execution, acceptance, result references, recovery, settlement, and bilateral delivery. Each is NotApplicable, Pending, Available, or Unavailable.

chio work collect

Reconcile finished work and record its results, with no second dispatch.

Command synopsistext
chio work collect [OPTIONS] --state <STATE> <ID>
  • <ID> Work handle, or the original command ID. Required.
  • --state <STATE> Private work state directory. Required.

chio work export

Export the signed records for a work commitment as an evidence package.

Command synopsistext
chio work export [OPTIONS] --state <STATE> --out <OUT> <ID>
  • <ID> Work handle, or the original command ID. Required.
  • --state <STATE> Private work state directory. Required.
  • --out <OUT> Evidence package directory. Required.

Read more in Workflow reference.