CLI Commands

Overview

Workflow Studio provides a CLI for building portable artifacts, managing deployments, and validating ownership configuration.

What deploy, activate, and rollback do

compute deploy uploads artifact bytes and manifest metadata to the compute-worker HTTP API. compute activate switches the active deployment pointer used for new runs. compute rollback re-activates a previous deployment ID. These commands do not provision or deploy infrastructure on Railway, EC2, GCP, or other platforms.

Build Workflow

1. Build Workflow Bundles

First, build your normal workflow bundles:

pnpm exec workflow build

2. Build Portable Artifact

Package the .well-known/workflow/v1/* into a portable artifact:

pnpm exec workflow-studio compute build

This creates:

.workflow-studio/dist/artifact.tgz
.workflow-studio/tmp/<deploymentId>/manifest.json

Deploy Commands

Deploy

Upload and create a deployment on the remote worker:

pnpm exec workflow-studio compute deploy \
  --artifact .workflow-studio/dist/artifact.tgz \
  --manifest .workflow-studio/tmp/<deploymentId>/manifest.json \
  --url "$WORKFLOW_COMPUTE_BASE_URL" \
  --api-key "$WORKFLOW_COMPUTE_API_KEY"

Activate

Activate a deployment to make it the active pointer:

pnpm exec workflow-studio compute activate \
  --deployment-id <deploymentId> \
  --url "$WORKFLOW_COMPUTE_BASE_URL" \
  --api-key "$WORKFLOW_COMPUTE_API_KEY"

Rollback

Roll back to a previous deployment:

pnpm exec workflow-studio compute rollback \
  --deployment-id <deploymentId> \
  --url "$WORKFLOW_COMPUTE_BASE_URL" \
  --api-key "$WORKFLOW_COMPUTE_API_KEY"

Typical Deployment Flow

Build: workflow build → workflow-studio compute build
Deploy: workflow-studio compute deploy (creates deployment)
Validate: workflow-studio compute validate-ownership (check config)
Activate: workflow-studio compute activate (sets active pointer)
Re-validate: workflow-studio compute validate-ownership --strict (verify)

Environment Variables

Common environment variables for CLI operations:

Variable	Description	Required
`WORKFLOW_COMPUTE_BASE_URL`	Remote worker base URL	Yes
`WORKFLOW_COMPUTE_API_KEY`	API key for worker authentication	Yes
`WORKFLOW_EXECUTION_MODE`	`local` or `remote` (optional override)	No
`WORKFLOW_EXECUTION_FAIL_POLICY`	`error` or `fallback-local` (optional override)	No

Invalid values for WORKFLOW_EXECUTION_MODE or WORKFLOW_EXECUTION_FAIL_POLICY fail fast during config resolution.

Next Steps

Review validation and ownership checks

On this page