Skip to content

kindgi flows

View as Markdown

Synopsis

Terminal window
kindgi flows <command>
Signature

Manage flow registrations: publish, list, versions, unregister, reinstate.

Commands

Command Description
kindgi flows list List registered flows (the latest version of each).
kindgi flows get Fetch a registered flow: its latest version, or the version given.
kindgi flows publish Register a flow definition at its version.
kindgi flows unregister Unregister a specific flow version: new runs of it are refused; kindgi flows reinstate brings it back.
kindgi flows versions List the registered versions of a flow.
kindgi flows reinstate Bring back an unregistered flow version.

See also

Synopsis

Terminal window
kindgi flows list [--name=<prefix>] [--include-retired] [--limit=<n>] [--cursor=<c>]
Signature

List registered flows (the latest version of each).

Options

Option Default Description
--cursor <value> none Resume after this cursor, from the previous page's nextCursor.
--include-retired off Include retired flows (every version unregistered), each as its highest version with unregisteredAt.
--limit <value> 25 (at most 100) The most to return (default 25, at most 100).
--name <value> none Only flows whose id starts with this.

Every command also takes the global flags.

Examples

List registered flows, retired ones too.

Terminal window
kindgi flows list --include-retired

See also

Synopsis

Terminal window
kindgi flows get <flow-id> [<version>]
Signature

Fetch a registered flow: its latest version, or the version given.

Options

Every command also takes the global flags.

Examples

Fetch a flow's latest version.

Terminal window
kindgi flows get acme.nightly-digest

Fetch one version of a flow.

Terminal window
kindgi flows get acme.nightly-digest 0.1.0

See also

Synopsis

Terminal window
kindgi flows publish --spec=<json-or-@file> [--project=<project-id>]
Signature

Register a flow definition at its version. The server checks it: no cycles, every node and edge resolves.

Options

Option Default Description
--project <value> the tenant's Default project The project to register the flow in, by id (default: the tenant's Default project).
--spec <value> required The flow definition as JSON, or @<file> to read it from a file. Required.

Every command also takes the global flags.

Examples

Register a flow definition from a file.

Terminal window
kindgi flows publish --spec=@flows/acme.nightly-digest.json

See also

Synopsis

Terminal window
kindgi flows unregister <flow-id> <version>
Signature

Unregister a specific flow version: new runs of it are refused; kindgi flows reinstate brings it back.

Options

Every command also takes the global flags.

Examples

Unregister a flow version: new runs of it are refused.

Terminal window
kindgi flows unregister acme.nightly-digest 0.1.0

See also

Synopsis

Terminal window
kindgi flows versions <flow-id> [--include-unregistered] [--limit=<n>] [--cursor=<c>]
Signature

List the registered versions of a flow.

Options

Option Default Description
--cursor <value> none Resume after this cursor, from the previous page's nextCursor.
--include-unregistered off Include unregistered versions (each with unregisteredAt), a retired flow's too.
--limit <value> 25 (at most 100) The most to return (default 25, at most 100).

Every command also takes the global flags.

Examples

List a flow's versions, unregistered ones too.

Terminal window
kindgi flows versions acme.nightly-digest --include-unregistered

See also

Synopsis

Terminal window
kindgi flows reinstate <flow-id> <version>
Signature

Bring back an unregistered flow version.

Options

Every command also takes the global flags.

Examples

Bring back an unregistered flow version.

Terminal window
kindgi flows reinstate acme.nightly-digest 0.1.0

See also