Workflow Commands

The workflow command group provides comprehensive workflow management capabilities including listing, inspecting, and executing workflows. These commands form the core of workflow orchestration in Compozy.

Overview

compozy workflow [command]

List Workflows

Browse available workflows with pagination and filtering options

Inspect Details

Get comprehensive workflow configurations, task definitions, and execution history

Execute Workflows

Run AI workflow orchestrations with real-time progress monitoring

workflow

Parent command for all workflow operations.

Usage

compozy workflow [command]

Available Subcommands

  • list - List workflows
  • get - Get detailed information about a workflow
  • execute - Execute a workflow

workflow list

Lists all workflows with their basic information including ID, name, status, and last execution details. Supports multiple output formats for both interactive use and automation scenarios.

Usage

compozy workflow list [flags]

workflow get

Retrieves comprehensive information about a workflow including configuration details, task definitions, agent assignments, execution history, and current status.

Usage

compozy workflow get <workflow-id> [flags]

Arguments

ArgumentDescriptionRequired
<workflow-id>The unique identifier of the workflowYes

Examples

# Get workflow details in TUI format
compozy workflow get data-analysis

# Get workflow with verbose output
compozy workflow get data-analysis --verbose

workflow execute

Execute a workflow with optional input parameters and real-time monitoring.

Usage

compozy workflow execute <workflow-id> [flags]

Arguments

ArgumentDescriptionRequired
<workflow-id>The unique identifier of the workflow to executeYes

Flags

Execution Control

FlagDescriptionDefault
--asyncRun asynchronously, return execution ID immediatelyfalse
--waitWait for completiontrue
--timeoutMaximum time to wait for completion30s

Input Parameters

FlagDescriptionFormat
--jsonInput parameters as a complete JSON objectJSON string
--paramIndividual input parameters (can be used multiple times)key=value
--input-fileRead input parameters from JSON fileFile path

Output Options

FlagDescriptionOptions/Default
--formatOutput formatauto | json | tui (default: auto)
--quietSuppress progress indicatorsfalse
--followFollow execution progress in real-timefalse

Examples

# Execute workflow and wait for completion
compozy workflow execute data-analysis

# Execute with timeout
compozy workflow execute data-analysis --timeout 300s

# Execute with progress following
compozy workflow execute data-analysis --follow

Next Steps

Now that you understand workflow command operations, explore these related concepts to build more sophisticated AI-powered workflows:

Workflow Development

Operations & Management