# GitLab 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 glab command with literal argv. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `arguments` | `string (CSV)` | `` | Required | ## `version` Report the installed glab CLI version. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | ## `auth_status` Check inherited GitLab authentication without interactive login. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `hostname` | `string` | `--hostname=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `repo_view` Inspect GitLab repository metadata without opening a browser. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_create` Create a noninteractive merge request with explicit title and description. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `title` | `string` | `--title=` | Required | | `description` | `string` | `--description=` | Required | | `sourceBranch` | `string` | `--source-branch=` | Omitted | | `targetBranch` | `string` | `--target-branch=` | Omitted | | `draft` | `boolean` | `--draft` | Omitted | | `yes` | `boolean` | `--yes` | `true` | | `labels` | `string (CSV)` | `--label=` | Omitted | | `reviewers` | `string (CSV)` | `--reviewer=` | Omitted | | `assignees` | `string (CSV)` | `--assignee=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_view` Read a merge request and its state. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `output` | `string (json, text)` | `--output=` | `"json"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_list` List merge requests in a machine-readable format. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `sourceBranch` | `string` | `--source-branch=` | Omitted | | `targetBranch` | `string` | `--target-branch=` | Omitted | | `output` | `string (json, text)` | `--output=` | `"json"` | | `perPage` | `integer` | `--per-page=` | `30` | | `page` | `integer` | `--page=` | `1` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_checkout` Check out a merge request locally. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `branch` | `string` | `--branch=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_note` Publish a pipeline comment on a merge request. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `message` | `string` | `--message=` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `mr_merge` Merge a selected merge request; source branch deletion remains opt-in. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `number` | `string` | `` | Required | | `yes` | `boolean` | `--yes` | `true` | | `squash` | `boolean` | `--squash` | Omitted | | `removeSourceBranch` | `boolean` | `--remove-source-branch` | Omitted | | `sha` | `string` | `--sha=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_create` Create a GitLab release and attach optional assets; existing releases are protected by default. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Required | | `files` | `string (CSV)` | `` | Omitted | | `name` | `string` | `--name=` | Omitted | | `notes` | `string` | `--notes=` | Omitted | | `notesFile` | `string` | `--notes-file=` | Omitted | | `ref` | `string` | `--ref=` | Omitted | | `noUpdate` | `boolean` | `--no-update` | `true` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_upload` Upload files to an existing GitLab release. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Required | | `files` | `string (CSV)` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `release_download` Download selected GitLab release assets. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `tag` | `string` | `` | Omitted | | `assetNames` | `string (CSV)` | `--asset-name=` | Omitted | | `directory` | `string` | `--dir=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_run` Create a GitLab pipeline with named variables or inputs. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `branch` | `string` | `--branch=` | Omitted | | `mr` | `boolean` | `--mr` | Omitted | | `variables` | `string (CSV)` | `--variables-env=` | Omitted | | `inputs` | `string (CSV)` | `--input=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_status` Inspect or watch a GitLab pipeline status. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `branch` | `string` | `--branch=` | Omitted | | `live` | `boolean` | `--live` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_get` Read detailed pipeline information. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `pipelineId` | `integer` | `--pipeline-id=` | Omitted | | `branch` | `string` | `--branch=` | Omitted | | `output` | `string (json, text)` | `--output=` | `"json"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_retry` Retry one explicitly selected GitLab CI job, optionally within a selected pipeline. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `job` | `string` | `` | Required | | `pipelineId` | `integer` | `--pipeline-id=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_cancel` Cancel one explicitly selected pipeline using glab ci cancel pipeline. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `pipelineId` | `integer` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ci_lint` Validate GitLab CI configuration using the native server lint API. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `repo` | `string` | `--repo=` | Omitted | | `file` | `string` | `` | Omitted | | `dryRun` | `boolean` | `--dry-run` | Omitted | | `ref` | `string` | `--ref=` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `api` Call the authenticated GitLab API with scalar fields or a body 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 |