# GitHub CLI module arguments Generated from [the CLI catalog](../../lib/cli/catalog.json). Every export requires a fresh `runDir`. Common fields are `project` (default `.`), `executable` (the CLI program or path), `timeoutMs` (default `900000`), and `artifacts` is a comma-separated NAME=PATH string in the public component contract. ## `run` Run any native gh command with literal argv. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `arguments` | `string (CSV)` | `` | Required | ## `version` Report the installed gh CLI version. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | ## `auth_status` Check existing GitHub authentication without interactive login. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `hostname` | `string` | `--hostname=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `repo_view` Inspect repository metadata. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `` | Omitted | | `jsonFields` | `string (CSV)` | `--json=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_create` Create a pull request with explicit noninteractive title and description. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `title` | `string` | `--title=` | Required | | `body` | `string` | `--body=` | Required | | `base` | `string` | `--base=` | Omitted | | `head` | `string` | `--head=` | Omitted | | `draft` | `boolean` | `--draft` | Omitted | | `labels` | `string (CSV)` | `--label=` | Omitted | | `reviewers` | `string (CSV)` | `--reviewer=` | Omitted | | `assignees` | `string (CSV)` | `--assignee=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_view` Read a pull request and its review state. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `jsonFields` | `string (CSV)` | `--json=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_list` List pull requests for automated review or release workflows. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `state` | `string (open, closed, merged, all)` | `--state=` | `"open"` | | `base` | `string` | `--base=` | Omitted | | `head` | `string` | `--head=` | Omitted | | `limit` | `integer` | `--limit=` | `30` | | `jsonFields` | `string (CSV)` | `--json=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_checkout` Check out a pull request into the working tree. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `branch` | `string` | `--branch=` | Omitted | | `detach` | `boolean` | `--detach` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_checks` Inspect or wait for pull request checks; native failing and pending statuses propagate. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `watch` | `boolean` | `--watch` | Omitted | | `failFast` | `boolean` | `--fail-fast` | Omitted | | `required` | `boolean` | `--required` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_comment` Publish a pipeline comment to a pull request. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `body` | `string` | `--body=` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pr_merge` Merge a reviewed pull request using an explicitly selected strategy; branch deletion is opt-in. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `method` | `string (squash, merge, rebase)` | `--` | Required | | `number` | `string` | `` | Required | | `auto` | `boolean` | `--auto` | Omitted | | `deleteBranch` | `boolean` | `--delete-branch` | Omitted | | `matchHeadCommit` | `string` | `--match-head-commit=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_create` Create a GitHub release and optionally attach release assets. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Required | | `files` | `string (CSV)` | `` | Omitted | | `title` | `string` | `--title=` | Omitted | | `notes` | `string` | `--notes=` | Omitted | | `notesFile` | `string` | `--notes-file=` | Omitted | | `target` | `string` | `--target=` | Omitted | | `draft` | `boolean` | `--draft` | Omitted | | `prerelease` | `boolean` | `--prerelease` | Omitted | | `generateNotes` | `boolean` | `--generate-notes` | Omitted | | `verifyTag` | `boolean` | `--verify-tag` | `true` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_upload` Upload assets to an existing release; replacement is opt-in. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Required | | `files` | `string (CSV)` | `` | Required | | `clobber` | `boolean` | `--clobber` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_download` Download selected release assets. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Omitted | | `patterns` | `string (CSV)` | `--pattern=` | Omitted | | `directory` | `string` | `--dir=` | Omitted | | `clobber` | `boolean` | `--clobber` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `workflow_run` Dispatch a GitHub Actions workflow with named scalar inputs. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `workflow` | `string` | `` | Required | | `ref` | `string` | `--ref=` | Omitted | | `inputs` | `string (CSV)` | `--raw-field=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `run_list` List workflow runs for pipeline orchestration. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `workflow` | `string` | `--workflow=` | Omitted | | `branch` | `string` | `--branch=` | Omitted | | `status` | `string` | `--status=` | Omitted | | `limit` | `integer` | `--limit=` | `20` | | `jsonFields` | `string (CSV)` | `--json=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `run_view` Inspect a workflow run and propagate its failure status. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `runId` | `string` | `` | Required | | `exitStatus` | `boolean` | `--exit-status` | `true` | | `log` | `boolean` | `--log` | Omitted | | `jsonFields` | `string (CSV)` | `--json=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `run_watch` Wait for a workflow run and propagate failure to the pipeline. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `runId` | `string` | `` | Required | | `exitStatus` | `boolean` | `--exit-status` | `true` | | `interval` | `integer` | `--interval=` | `3` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `run_rerun` Rerun a selected workflow run or its failed jobs. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `runId` | `string` | `` | Required | | `failed` | `boolean` | `--failed` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `run_cancel` Cancel a selected workflow run. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `runId` | `string` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `api` Call the authenticated GitHub API using scalar fields or a request file. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `endpoint` | `string` | `` | Required | | `method` | `string` | `--method=` | Omitted | | `hostname` | `string` | `--hostname=` | Omitted | | `fields` | `string (CSV)` | `--raw-field=` | Omitted | | `inputFile` | `string` | `--input=` | Omitted | | `paginate` | `boolean` | `--paginate` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted |