CLI
Manage and trigger workflows.
workflows list
List workflows for a project.
strait workflows list --project proj_1| Flag | Type | Description |
|---|---|---|
--project | string | Project ID |
workflows get
Get a workflow by ID or slug.
strait workflows get data-pipelineworkflows describe
Show workflow details and step dependency graph.
strait workflows describe data-pipelineworkflows create
Create a workflow with steps.
strait workflows create \
--name "Data Pipeline" \
--slug data-pipeline \
--steps-json '[{"job_id": "job_1", "step_ref": "extract"}, {"job_id": "job_2", "step_ref": "transform", "depends_on": ["extract"]}]'| Flag | Type | Description |
|---|---|---|
--project | string | Project ID |
--name | string | Workflow name |
--slug | string | Workflow slug |
--description | string | Workflow description |
--steps-json | string | JSON array of workflow steps |
workflows update
Update an existing workflow.
strait workflows update data-pipeline --enabled=false| Flag | Type | Description |
|---|---|---|
--name | string | Workflow name |
--slug | string | Workflow slug |
--description | string | Workflow description |
--enabled | bool | Workflow enabled state |
--steps-json | string | JSON array of workflow steps |
workflows delete
Delete a workflow.
strait workflows delete data-pipeline --yes| Flag | Type | Default | Description |
|---|---|---|---|
--yes | bool | false | Skip confirmation prompt |
workflows runs
List runs for a specific workflow.
strait workflows runs data-pipeline --limit 20| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 50 | Maximum runs to return |
--offset | int | 0 | Pagination offset |
workflows trigger
Trigger a workflow run.
strait workflows trigger data-pipeline --payload '{"source": "s3://bucket/data.csv"}'| Flag | Type | Description |
|---|---|---|
--payload | string | Inline JSON payload |
--payload-file | string | Path to payload JSON file |
Was this page helpful?