Workflow Commands
The cre workflow commands manage workflows throughout their entire lifecycle, from local testing to deployment and ongoing management.
cre workflow simulate
Compiles your workflow to WASM and executes it in a local simulation environment. This is the core command for testing and debugging your workflow.
Usage:
cre workflow simulate <workflow-name-or-path> [flags]
Arguments:
<workflow-name-or-path>— (Required) Workflow folder name (e.g.,my-workflow) or path (e.g.,./my-workflow). When run from the project root, you can use just the folder name. The CLI looks for aworkflow.yamlfile in the workflow directory.
Flags:
Flag | Description |
|---|---|
--broadcast | Broadcast onchain write transactions (default: false). Without this flag, a dry run is performed |
-g, --engine-logs | Enable non-fatal engine logging |
--non-interactive | Run without prompts; requires --trigger-index and inputs for the selected trigger type |
--trigger-index <int> | Index of the trigger to run (0-based). Required when using --non-interactive |
--http-payload <string> | HTTP trigger payload as JSON string or path to JSON file (with or without @ prefix) |
--evm-tx-hash <string> | EVM trigger transaction hash (0x...). For EVM log triggers |
--evm-event-index <int> | EVM trigger log index (0-based). For EVM log triggers |
Examples:
-
Basic simulation
cre workflow simulate ./my-workflow --target local-simulation -
Broadcast real onchain transactions
cre workflow simulate ./my-workflow --broadcast --target local-simulation
cre workflow deploy
Deploys a workflow to the Workflow Registry contract. This command compiles your workflow, uploads the artifacts to the CRE Storage Service, and registers the workflow onchain.
Usage:
cre workflow deploy <workflow-name-or-path> [flags]
Arguments:
<workflow-name-or-path>— (Required) Workflow folder name (e.g.,my-workflow) or path (e.g.,./my-workflow)
Flags:
Flag | Description |
|---|---|
-r, --auto-start | Activate the workflow immediately after deployment (default: true) |
-o, --output | Output file for the compiled WASM binary encoded in base64 (default: "./binary.wasm.br.b64") |
--unsigned | Return the raw transaction instead of sending it to the network |
--yes | Skip the confirmation prompt and proceed with the operation |
Examples:
-
Deploy workflow with auto-start (default behavior)
cre workflow deploy my-workflow --target production-settings -
Deploy without auto-starting
cre workflow deploy my-workflow --auto-start=false --target production-settings -
Deploy and save the compiled binary to a custom location
cre workflow deploy my-workflow --output ./dist/workflow.wasm.br.b64
For more details, see Deploying Workflows.
cre workflow activate
Changes the workflow status to active on the Workflow Registry contract. Active workflows can respond to their configured triggers.
Usage:
cre workflow activate <workflow-name-or-path> [flags]
Arguments:
<workflow-name-or-path>— (Required) Workflow folder name (e.g.,my-workflow) or path (e.g.,./my-workflow)
Flags:
| Flag | Description |
|---|---|
--unsigned | Return the raw transaction instead of sending it to the network |
--yes | Skip the confirmation prompt and proceed with the operation |
Example:
cre workflow activate ./my-workflow --target production-settings
For more details, see Activating & Pausing Workflows.
cre workflow pause
Changes the workflow status to paused on the Workflow Registry contract. Paused workflows will not respond to triggers.
Usage:
cre workflow pause <workflow-name-or-path> [flags]
Arguments:
<workflow-name-or-path>— (Required) Workflow folder name (e.g.,my-workflow) or path (e.g.,./my-workflow)
Flags:
| Flag | Description |
|---|---|
--unsigned | Return the raw transaction instead of sending it to the network |
--yes | Skip the confirmation prompt and proceed with the operation |
Example:
cre workflow pause ./my-workflow --target production-settings
For more details, see Activating & Pausing Workflows.
cre workflow delete
Deletes a workflow from the Workflow Registry.
Usage:
cre workflow delete <workflow-name-or-path> [flags]
Arguments:
<workflow-name-or-path>— (Required) Workflow folder name (e.g.,my-workflow) or path (e.g.,./my-workflow)
Flags:
| Flag | Description |
|---|---|
--unsigned | Return the raw transaction instead of sending it to the network |
--yes | Skip the confirmation prompt and proceed with the operation |
Example:
cre workflow delete ./my-workflow --target production-settings
For more details, see Deleting Workflows.
Workflow lifecycle
The typical workflow lifecycle uses these commands in sequence:
- Develop locally — Write and iterate on your workflow code
cre workflow simulate— Test your workflow in a local simulation environmentcre workflow deploy— Deploy your workflow to the registry (auto-starts by default)cre workflow pause/cre workflow activate— Control workflow execution as neededcre workflow deploy(again) — Deploy updates (replaces the existing workflow)cre workflow delete— Remove the workflow when no longer needed
Learn more
- Deploying Workflows — Detailed deployment guide
- Activating & Pausing Workflows — Managing workflow state
- Updating Deployed Workflows — Version management
- Deleting Workflows — Cleanup and removal