Parallel Works

pw workflows run

pw workflows run

Run a saved workflow, a local YAML file, or a workflow in a repository

pw workflows run <name-file-or-repo> [flags]

Examples

  pw workflows run my-workflow
  
  # Run a marketplace workflow by slug
  pw workflows run marketplace/my-marketplace-item
  
  # Run a workflow from a local YAML file, or the workflow.yaml (or workflow.yml)
  # in a local directory
  pw workflows run ./my-workflow.yaml
  pw workflows run ./my-workflow
  
  # Run workflow.yaml (or workflow.yml) from the root of a repository
  pw workflows run github.com/parallelworks/my-workflow
  pw workflows run https://gitlab.example.com/group/my-workflow
  
  # Run a repository at a specific branch, tag, or commit
  pw workflows run github.com/parallelworks/my-workflow@v1.2.0
  pw workflows run https://gitlab.example.com/group/my-workflow@main
  
  # Run a workflow that lives in a subdirectory, by file or by directory
  pw workflows run github.com/parallelworks/workflows/examples/slurm/workflow.yaml
  pw workflows run github.com/parallelworks/workflows/examples/slurm@v1.2.0
  
  # Private repositories are read with the credentials already on this machine
  # (GH_TOKEN, GITHUB_TOKEN, "gh auth login", "glab auth login", GITLAB_TOKEN, or a
  # git credential helper), and otherwise by the platform as your connected account
  pw workflows run github.com/parallelworks/my-private-workflow
  
  # Run with input parameters
  pw workflows run -i '{"param1": "value1"}' my-workflow
  
  # Run with inputs from a JSON file
  pw workflows run -i inputs.json my-workflow
  
  # Run with saved inputs
  pw workflows run --saved-inputs my-inputs my-workflow
  
  # Run with saved inputs, overriding individual values from --inputs
  pw workflows run --saved-inputs my-inputs -i '{"param1": "value1"}' my-workflow
  
  # Validate workflow without executing (dry run)
  pw workflows run --dry-run my-workflow
  
  # Run with a custom display name
  pw workflows run --name "Test run with new params" my-workflow
  
  # Output as JSON
  pw workflows run -o json my-workflow

Options

      --dry-run               Validate only, don't execute
  -h, --help                  help for run
  -i, --inputs string         JSON string or file path with input values
      --name string           Custom display name for the run
  -o, --output string         Output format (interactive, json, text) (default "interactive")
      --saved-inputs string   Name of saved inputs on the workflow to load input values from (overridden by --inputs)
      --trust                 Grant the workflow every account variable it declares, without prompting

Options inherited from parent commands

      --context string         The context to use. Overrides PW_CONTEXT environment variable and current context from config.
      --platform-host string   The Parallel Works ACTIVATE platform host to use. Overrides PW_PLATFORM_HOST environment variable and the current context's server.
  -v, --verbose                Enable verbose logging

SEE ALSO