Workflow Commands

Commands for managing workflows and workflow executions.

workflow

Manage workflows and workflow executions.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">subcomman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

workflow list

List all workflows in the workspace.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">list</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • --json - Output as JSON

workflow get

Get workflow details.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">get</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nameOrI</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • nameOrId - Workflow name or ID (required)

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • --json - Output as JSON

workflow start

Start a workflow execution.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">start</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nameOrI</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • nameOrId - Workflow name or ID (required)

Options:

  • -m, --machineuser - Machine user name (required)
  • -g, --arg - Workflow argument (JSON string)
  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • --wait - Wait for execution to complete
  • --interval - Polling interval when using --wait (default: 3s)
  • --json - Output as JSON

Usage Examples:

<span><span style="color: var(--shiki-token-comment)"># Start a workflow</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">start</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">my-workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-m</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">admin-machine-user</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Start with argument</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">start</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">my-workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-m</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">admin</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-g</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">&#39;{&quot;userId&quot;: &quot;123&quot;}&#39;</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Start and wait for completion</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">start</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">my-workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-m</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">admin</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">--wait</span></span>
<span></span>

workflow executions

List or get workflow executions.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> [executionId] [options]</span></span>
<span></span>

Arguments:

  • executionId - Execution ID (optional, if provided shows details)

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • -n, --workflow-name - Filter by workflow name (list mode only)
  • -s, --status - Filter by status: PENDING, PENDING_RESUME, RUNNING, SUCCESS, FAILED (list mode only)
  • --wait - Wait for execution to complete (detail mode only)
  • --interval - Polling interval when using --wait (default: 3s)
  • --logs - Display job execution logs (detail mode only)
  • --json - Output as JSON

Usage Examples:

<span><span style="color: var(--shiki-token-comment)"># List all executions</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Filter by workflow name</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-n</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">my-workflow</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Filter by status</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-s</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">RUNNING</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Get execution details</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">execution-i</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Get execution details with logs</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">execution-i</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">--logs</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># Wait for execution to complete</span></span>
<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">executions</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">execution-i</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">--wait</span></span>
<span></span>

workflow resume

Resume a failed or pending workflow execution.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workflow</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">resume</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">executionI</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • executionId - Failed or pending execution ID (required)

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • --wait - Wait for execution to complete after resuming
  • --interval - Polling interval when using --wait (default: 3s)
  • --json - Output as JSON