gh-workflow

List, view, and run GitHub Actions workflows.

TLDR

Interactively select a workflow to view the latest jobs for

$ gh workflow view
copy


View a specific workflow in the default browser
$ gh workflow view [id|workflow_name|filename.yml] --web
copy


Display the YAML definition of a specific workflow
$ gh workflow view [id|workflow_name|filename.yml] --yaml
copy


Display the YAML definition for a specific Git branch or tag
$ gh workflow view [id|workflow_name|filename.yml] --ref [branch_or_tag_name] --yaml
copy


List workflow files (use --all to include disabled workflows)
$ gh workflow list
copy


Run a manual workflow with parameters
$ gh workflow run [id|workflow_name|filename.yml] --raw-field [param1]=[value1] --raw-field [param2]=[value2]
copy


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_or_tag_name]
copy


Enable or disable a specific workflow
$ gh workflow [enable|disable] [id|workflow_name|filename.yml]
copy

SYNOPSIS

gh workflow <command> [flags]

DESCRIPTION

List, view, and run workflows in GitHub Actions.

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

gh(1)

Copied to clipboard