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
Inspect Details
Execute Workflows
workflow
Parent command for all workflow operations.
Usage
compozy workflow [command]
Available Subcommands
list
- List workflowsget
- Get detailed information about a workflowexecute
- 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
Argument | Description | Required |
---|---|---|
<workflow-id> | The unique identifier of the workflow | Yes |
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
Argument | Description | Required |
---|---|---|
<workflow-id> | The unique identifier of the workflow to execute | Yes |
Flags
Execution Control
Flag | Description | Default |
---|---|---|
--async | Run asynchronously, return execution ID immediately | false |
--wait | Wait for completion | true |
--timeout | Maximum time to wait for completion | 30s |
Input Parameters
Flag | Description | Format |
---|---|---|
--json | Input parameters as a complete JSON object | JSON string |
--param | Individual input parameters (can be used multiple times) | key=value |
--input-file | Read input parameters from JSON file | File path |
Output Options
Flag | Description | Options/Default |
---|---|---|
--format | Output format | auto | json | tui (default: auto) |
--quiet | Suppress progress indicators | false |
--follow | Follow execution progress in real-time | false |
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
Configuration Commands
The `compozy config` command group provides comprehensive tools for managing, validating, and diagnosing your Compozy configuration. These commands ensure your setup is correct, optimized, and ready for production deployment.
MCP Proxy Commands
Manage Model Context Protocol (MCP) servers and proxy operations with the `compozy mcp-proxy` binary. The MCP proxy server enables HTTP-based access to MCP servers, providing seamless integration between AI agents and external tools.