System Grab Bag

View all TLDR pages from common (or from all pages)

gh workflow

List, view, and run GitHub Actions workflows. More information: https://cli.github.com/manual/gh_workflow.
  • 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}}

License and Disclaimer

The content on this page is copyright © 2014—present the tldr-pages team and contributors.
This page is used with permission under Creative Commons Attribution 4.0 International License.

While we do attempt to make sure content is accurate, there isn't a warranty of any kind.