gh-workflow:tldr:71ea7

gh-workflow: Run a manual workflow with parameters.

$ gh workflow run ${select} ${--raw-field param1=value1 --raw-field param2=value2 ---}

try on your machine

The command you provided is intended for GitHub CLI (command-line interface) and it is used to run a workflow.

Here's an explanation of the command structure:

gh workflow run: This is the base command used to run a workflow on GitHub.
${select}: This refers to the name or ID of the workflow you want to run. You need to replace ${select} with the actual name or ID of the workflow you wish to execute.
--raw-field: This flag is used to provide raw input field values to the workflow. Multiple --raw-field flags can be used to pass different field-value pairs.
param1=value1 and param2=value2: These represent specific field-value pairs that you want to pass to the workflow. You can replace param1 and param2 with the actual parameter names and value1 and value2 with the corresponding values you want to assign to them.
---: This triple dash is used to mark the end of options and the beginning of positional arguments.

To use this command effectively, you should replace ${select} with a valid workflow name or ID and provide the necessary --raw-field arguments followed by their corresponding values.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.

back to the gh tool