Skip to content

civex workflow

Manage and run data processing workflows

Command Description
list List all workflow definitions in _civex/workflows/.
run Run a workflow against a specific record.

civex workflow list

List all workflow definitions in _civex/workflows/.

Usage

civex workflow list

civex workflow run

Run a workflow against a specific record.

Declared workflow inputs can be supplied with --input name=value. For inputs of type 'files', value is a glob pattern (e.g. --input files=*.csv). Supplied values are pre-seeded as input. and can be referenced in step inputs like: files: input.files

Usage

civex workflow run [OPTIONS] NAME

Arguments

Argument Type Required Description
NAME str yes Workflow name or filename stem

Options

Option Type Default Description
--record, -r str Record ID or short prefix (required)
--input, -i str Workflow input as name=value. For 'files' inputs, value is a glob pattern.