docs/content/actions/managing-workflow-runs/manually-running-a-workflow.md

title, intro, product, versions

title	intro	product	versions
Manually running a workflow	When a workflow is configured to run on the `workflow_dispatch` event, you can run the workflow using the Actions tab on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_cli %}, or the REST API.	{% data reusables.gated-features.actions %}	free-pro-team enterprise-server github-ae * >=2.22 *

{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %}

Configuring a workflow to run manually

To run a workflow manually, the workflow must be configured to run on the workflow_dispatch event. For more information about configuring the workflow_dispatch event, see "Events that trigger workflows".

Running a workflow on {% data variables.product.prodname_dotcom %}

To trigger the workflow_dispatch event on {% data variables.product.prodname_dotcom %}, your workflow must be in the default branch. Follow these steps to manually trigger a workflow run.

{% data reusables.repositories.permissions-statement-write %}

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}

1. In the left sidebar, click the workflow you want to run.
2. Above the list of workflow runs, select Run workflow.
3. Select the branch where the workflow will run and type the input parameters used by the workflow. Click Run workflow.

Running a workflow using {% data variables.product.prodname_cli %}

{% data reusables.actions.actions-cli %}

To run a workflow, use the workflow run subcommand. Replace the workflow 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, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow.

gh workflow run <em>workflow</em>

If your workflow accepts inputs, {% data variables.product.prodname_cli %} will prompt you to enter them. Alternatively, you can use -f or -F to add an input in key=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 <em>workflow</em> --ref <em>branch-name</em>

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

gh run watch

Running a workflow using the REST API

When using the REST API, you configure the inputs and ref as request body parameters. If the inputs are omitted, the default values defined in the workflow file are used.

For more information about using the REST API, see the "Create a workflow dispatch event."