Workflow Commands

Commands for managing workflows and workflow executions.

workflow

Manage workflows and workflow executions.

Usage

tailor-sdk workflow [command]

Commands

Command	Description
workflow list	List all workflows in the workspace.
workflow get	Get workflow details.
workflow start	Start a workflow execution.
workflow executions	List or get workflow executions.
workflow resume	Resume a failed or pending workflow execution.

workflow list

List all workflows in the workspace.

Usage

tailor-sdk workflow list [options]

Options

Option	Alias	Description	Required	Default
--json	-j	Output as JSON	No	false
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-
--profile <PROFILE>	-p	Workspace profile	No	-

workflow get

Get workflow details.

Usage

tailor-sdk workflow get [options] <name>

Arguments

Argument	Description	Required
name	Workflow name	Yes

Options

Option	Alias	Description	Required	Default
--json	-j	Output as JSON	No	false
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-
--profile <PROFILE>	-p	Workspace profile	No	-

workflow start

Start a workflow execution.

Usage

tailor-sdk workflow start [options] <name>

Arguments

Argument	Description	Required
name	Workflow name	Yes

Options

Option	Alias	Description	Required	Default
--json	-j	Output as JSON	No	false
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-
--profile <PROFILE>	-p	Workspace profile	No	-
--config <CONFIG>	-c	Path to SDK config file	No	"tailor.config.ts"
--machineuser <MACHINEUSER>	-m	Machine user name	Yes	-
--arg <ARG>	-a	Workflow argument (JSON string)	No	-
--wait	-W	Wait for execution to complete	No	false
--interval <INTERVAL>	-i	Polling interval when using --wait (e.g., '3s', '500ms', '1m')	No	"3s"
--logs	-l	Display job execution logs after completion (requires --wait)	No	false

workflow executions

List or get workflow executions.

Usage

tailor-sdk workflow executions [options] [executionId]

Arguments

Argument	Description	Required
executionId	Execution ID (if provided, shows details)	No

Options

Option	Alias	Description	Required	Default
--json	-j	Output as JSON	No	false
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-
--profile <PROFILE>	-p	Workspace profile	No	-
--workflow-name <WORKFLOW_NAME>	-n	Filter by workflow name (list mode only)	No	-
--status <STATUS>	-s	Filter by status (list mode only)	No	-
--wait	-W	Wait for execution to complete	No	false
--interval <INTERVAL>	-i	Polling interval when using --wait (e.g., '3s', '500ms', '1m')	No	"3s"
--logs	-	Display job execution logs (detail mode only)	No	false

workflow resume

Resume a failed or pending workflow execution.

Usage

tailor-sdk workflow resume [options] <executionId>

Arguments

Argument	Description	Required
executionId	Failed execution ID	Yes

Options

Option	Alias	Description	Required	Default
--json	-j	Output as JSON	No	false
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-
--profile <PROFILE>	-p	Workspace profile	No	-
--wait	-W	Wait for execution to complete	No	false
--interval <INTERVAL>	-i	Polling interval when using --wait (e.g., '3s', '500ms', '1m')	No	"3s"
--logs	-l	Display job execution logs after completion (requires --wait)	No	false

Usage Examples:

# Start a workflow
tailor-sdk workflow start my-workflow -m admin-machine-user

# Start with argument
tailor-sdk workflow start my-workflow -m admin -a '{"userId": "123"}'

# Start and wait for completion
tailor-sdk workflow start my-workflow -m admin -W

Usage Examples:

# List all executions
tailor-sdk workflow executions

# Filter by workflow name
tailor-sdk workflow executions -n my-workflow

# Filter by status
tailor-sdk workflow executions -s RUNNING

# Get execution details
tailor-sdk workflow executions <execution-id>

# Get execution details with logs
tailor-sdk workflow executions <execution-id> --logs

# Wait for execution to complete
tailor-sdk workflow executions <execution-id> -W