status
Retrieve the current status of a Git repository, including staged changes, untracked files, branch details, and stash information, using customizable parameters for detailed or concise output.
Instructions
Get the current git repository status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aheadBehind | No | Display detailed ahead/behind counts relative to upstream branch (--ahead-behind, --no-ahead-behind) | |
| branch | No | Show the branch and tracking info even in short-format (-b, --branch) | |
| column | No | Display untracked files in columns (--column[=<options>], --no-column) | |
| findRenames | No | Turn on rename detection, optionally set similarity threshold (--find-renames[=<n>]) | |
| ignoreSubmodules | No | Ignore changes to submodules (--ignore-submodules[=<when>]) | |
| ignored | No | Show ignored files as well (--ignored[=<mode>]) | |
| long | No | Give the output in the long-format (--long, default) | |
| pathspec | No | Limit the output to the given paths | |
| renames | No | Turn on/off rename detection (--renames, --no-renames) | |
| repoPath | Yes | Absolute path to the git repository | |
| short | No | Give the output in the short-format (-s, --short) | |
| showStash | No | Show the number of entries currently stashed away (--show-stash) | |
| untrackedFiles | No | Show untracked files (-u[<mode>], --untracked-files[=<mode>]) | |
| verbose | No | Show textual changes that are staged to be committed (-v, --verbose, can be specified twice) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"aheadBehind": {
"description": "Display detailed ahead/behind counts relative to upstream branch (--ahead-behind, --no-ahead-behind)",
"type": "boolean"
},
"branch": {
"description": "Show the branch and tracking info even in short-format (-b, --branch)",
"type": "boolean"
},
"column": {
"description": "Display untracked files in columns (--column[=<options>], --no-column)",
"type": [
"boolean",
"string"
]
},
"findRenames": {
"anyOf": [
{
"type": "boolean"
},
{
"maximum": 100,
"minimum": 0,
"type": "integer"
}
],
"description": "Turn on rename detection, optionally set similarity threshold (--find-renames[=<n>])"
},
"ignoreSubmodules": {
"description": "Ignore changes to submodules (--ignore-submodules[=<when>])",
"enum": [
"none",
"untracked",
"dirty",
"all"
],
"type": "string"
},
"ignored": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"traditional",
"no",
"matching"
],
"type": "string"
}
],
"description": "Show ignored files as well (--ignored[=<mode>])"
},
"long": {
"description": "Give the output in the long-format (--long, default)",
"type": "boolean"
},
"pathspec": {
"description": "Limit the output to the given paths",
"items": {
"type": "string"
},
"type": "array"
},
"renames": {
"description": "Turn on/off rename detection (--renames, --no-renames)",
"type": "boolean"
},
"repoPath": {
"description": "Absolute path to the git repository",
"type": "string"
},
"short": {
"description": "Give the output in the short-format (-s, --short)",
"type": "boolean"
},
"showStash": {
"description": "Show the number of entries currently stashed away (--show-stash)",
"type": "boolean"
},
"untrackedFiles": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"no",
"normal",
"all"
],
"type": "string"
}
],
"description": "Show untracked files (-u[<mode>], --untracked-files[=<mode>])"
},
"verbose": {
"anyOf": [
{
"type": "boolean"
},
{
"maximum": 2,
"minimum": 0,
"type": "integer"
}
],
"description": "Show textual changes that are staged to be committed (-v, --verbose, can be specified twice)"
}
},
"required": [
"repoPath"
],
"type": "object"
}