# Git 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 git command with literal argv. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `arguments` | `string (CSV)` | `` | Required | ## `version` Report the installed git CLI version. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | ## `clone` Clone a repository with optional shallow, partial and submodule checkout. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `branch` | `string` | `--branch=` | Omitted | | `depth` | `integer` | `--depth=` | Omitted | | `filter` | `string` | `--filter=` | Omitted | | `recursive` | `boolean` | `--recurse-submodules` | Omitted | | `singleBranch` | `boolean` | `--single-branch` | Omitted | | `url` | `string` | `` | Required | | `directory` | `string` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `fetch` Fetch selected refs and tags without merging them. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `prune` | `boolean` | `--prune` | Omitted | | `tags` | `boolean` | `--tags` | Omitted | | `depth` | `integer` | `--depth=` | Omitted | | `remote` | `string` | `` | `"origin"` | | `refspecs` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `checkout` Check out a revision while retaining native dirty-worktree safety checks. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `detach` | `boolean` | `--detach` | Omitted | | `ref` | `string` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `status` Inspect checkout and index state with stable machine-readable output. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `porcelain` | `string (v1, v2)` | `--porcelain=` | `"v1"` | | `branch` | `boolean` | `--branch` | Omitted | | `paths` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `diff` Compare source revisions or the working tree and optionally fail on differences. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `exitCode` | `boolean` | `--exit-code` | `true` | | `cached` | `boolean` | `--cached` | Omitted | | `stat` | `boolean` | `--stat` | Omitted | | `revisions` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `log` Read bounded commit history for release notes or change detection. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `maxCount` | `integer` | `--max-count=` | `20` | | `format` | `string` | `--format=` | `"%H %s"` | | `revision` | `string` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `show` Inspect a selected commit, tree or versioned file. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `format` | `string` | `--format=` | Omitted | | `stat` | `boolean` | `--stat` | Omitted | | `object` | `string` | `` | `"HEAD"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `rev_parse` Resolve an exact commit or object identifier. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `verify` | `boolean` | `--verify` | `true` | | `revision` | `string` | `` | `"HEAD"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `describe` Derive a release identifier from Git tags and commit history. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `tags` | `boolean` | `--tags` | `true` | | `always` | `boolean` | `--always` | `true` | | `match` | `string` | `--match=` | Omitted | | `revision` | `string` | `` | `"HEAD"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `add` Stage explicitly selected paths without implicitly staging all files. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `paths` | `string (CSV)` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `commit` Create a commit from staged changes using the inherited Git author identity. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `message` | `string` | `--message=` | Required | | `allowEmpty` | `boolean` | `--allow-empty` | Omitted | | `signoff` | `boolean` | `--signoff` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `tag` Create an explicitly named release tag without forcing replacement. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `message` | `string` | `--message=` | Omitted | | `sign` | `boolean` | `--sign` | Omitted | | `name` | `string` | `` | Required | | `target` | `string` | `` | `"HEAD"` | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `push` Push selected refs; force updates and tag publication are opt-in. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `tags` | `boolean` | `--tags` | Omitted | | `atomic` | `boolean` | `--atomic` | Omitted | | `setUpstream` | `boolean` | `--set-upstream` | Omitted | | `forceWithLease` | `boolean` | `--force-with-lease` | Omitted | | `remote` | `string` | `` | `"origin"` | | `refspecs` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `pull` Update the checkout, requiring a fast-forward by default. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `ffOnly` | `boolean` | `--ff-only` | `true` | | `remote` | `string` | `` | `"origin"` | | `branch` | `string` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `submodule_update` Initialize and update submodules at their committed revisions. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `init` | `boolean` | `--init` | `true` | | `recursive` | `boolean` | `--recursive` | `true` | | `depth` | `integer` | `--depth=` | Omitted | | `paths` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `ls_remote` Inspect remote refs without checking out or modifying repository contents. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `tags` | `boolean` | `--tags` | Omitted | | `heads` | `boolean` | `--heads` | Omitted | | `remote` | `string` | `` | `"origin"` | | `patterns` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `archive` Create a source release archive from a selected Git tree. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `format` | `string (tar, zip)` | `--format=` | `"tar"` | | `output` | `string` | `--output=` | Required | | `prefix` | `string` | `--prefix=` | Omitted | | `tree` | `string` | `` | `"HEAD"` | | `paths` | `string (CSV)` | `` | Omitted | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `config_get` Read one configured Git value without modifying configuration. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `key` | `string` | `` | Required | | `extraArgs` | `string (CSV)` | `` | Omitted | ## `remote_get_url` Read the configured repository remote URL. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `remote` | `string` | `` | `"origin"` | | `extraArgs` | `string (CSV)` | `` | Omitted |