1. On GitHub, navigate to the main page of the repository.

2. Under your repository name, click Actions.

   

3. In the left sidebar, click the name of the workflow you want to run.

   

4. Above the list of workflow runs, click theRun workflow button.

   Note

   To see theRun workflow button, your workflow file must use theworkflow_dispatch event trigger. Only workflow files that use theworkflow_dispatch event trigger will have the option to run the workflow manually using theRun workflow button. For more information about configuring theworkflow_dispatch event, seeEvents that trigger workflows.

   

5. Select theBranch dropdown menu and click a branch to run the workflow on.

6. If the workflow requires input, fill in the fields.

7. ClickRun workflow.

To run a workflow, use theworkflow run subcommand. Replace theworkflow parameter with either the name, ID, or file name of the workflow you want to run. For example,"Link Checker",1234567, or"link-check-test.yml". If you don't specify a workflow, GitHub CLI returns an interactive menu for you to choose a workflow.

gh workflow run WORKFLOW

If your workflow accepts inputs, GitHub CLI will prompt you to enter them. Alternatively, you can use-f or-F to add an input inkey=value format. Use-F to read from a file.

gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt

You can also pass inputs as JSON by using standard input.

echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json

To run a workflow on a branch other than the repository's default branch, use the--ref flag.

gh workflow run WORKFLOW --ref BRANCH

To view the progress of the workflow run, use therun watch subcommand and select the run from the interactive list.

gh run watch

Note

You can define up to 10inputs for aworkflow_dispatch event.