gh-workflow - Man Page
View details about GitHub Actions workflows
Examples (TL;DR)
- Interactively select a workflow to view the latest jobs for:
gh workflow view
- View a specific workflow in the default browser:
gh workflow view id|workflow_name|filename.yml --web
- Display the YAML definition of a specific workflow:
gh workflow view id|workflow_name|filename.yml --yaml
- Display the YAML definition for a specific Git branch or tag:
gh workflow view id|workflow_name|filename.yml --ref branch|tag_name --yaml
- List workflow files (use
--all
to include disabled workflows):gh workflow list
- Run a manual workflow with parameters:
gh workflow run id|workflow_name|filename.yml --raw-field param1=value1 --raw-field param2=value2 ...
- Run a manual workflow using a specific branch or tag with JSON parameters from
stdin
:echo '{"param1": "value1", "param2": "value2", ...}' | gh workflow run id|workflow_name|filename.yml --ref branch|tag_name
- Enable or disable a specific workflow:
gh workflow enable|disable id|workflow_name|filename.yml
Synopsis
gh workflow <command> [flags]
Description
List, view, and run workflows in GitHub Actions.
Available Commands
- gh-workflow-disable(1)
Disable a workflow
- gh-workflow-enable(1)
Enable a workflow
- gh-workflow-list(1)
List workflows
- gh-workflow-run(1)
Run a workflow by creating a workflow_dispatch event
- gh-workflow-view(1)
View the summary of a workflow
Options
- -R, --repo <[HOST/]OWNER/REPO>
Select another repository using the [HOST/]OWNER/REPO format
See Also
Referenced By
gh(1), gh-workflow-disable(1), gh-workflow-enable(1), gh-workflow-list(1), gh-workflow-run(1), gh-workflow-view(1).
Jul 2024 GitHub CLI manual