{ "content": [ { "type": "text", "text": "# GIT-STATUS (man)\n\n## NAME\n\ngit-status - Show the working tree status\n\n## SYNOPSIS\n\ngit status [...] [--] [...]\n\n## DESCRIPTION\n\nDisplays paths that have differences between the index file and the current HEAD commit,\npaths that have differences between the working tree and the index file, and paths in the\nworking tree that are not tracked by Git (and are not ignored by gitignore(5)). The first are\nwhat you would commit by running git commit; the second and third are what you could commit\nby running git add before running git commit.\n\n## TLDR\n\n> Show the changes to files in a Git repository.\n\n- Show untracked and changed files which are not yet added for commit:\n `git status`\n- Give output in short format:\n `git status {{-s|--short}}`\n- Show output in short format along with branch info:\n `git status {{-sb|--short --branch}}`\n- Show the changes in staged files (like `git diff --cached`):\n `git status {{-v|--verbose}}`\n- Show the changes in all tracked files (like `git diff HEAD`):\n `git status {{-vv|--verbose --verbose}}`\n- Show the number of entries currently stashed away:\n `git status --show-stash`\n- Don't show untracked files in the output:\n `git status {{-uno|--untracked-files=no}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (8 subsections)\n- **OUTPUT** (7 subsections)\n- **CONFIGURATION**\n- **BACKGROUND REFRESH**\n- **SEE ALSO**\n- **GIT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "GIT-STATUS", "section": "", "mode": "man", "summary": "git-status - Show the working tree status", "synopsis": "git status [...] [--] [...]", "tldr_summary": "Show the changes to files in a Git repository.", "tldr_examples": [ { "description": "Show untracked and changed files which are not yet added for commit", "command": "git status" }, { "description": "Give output in short format", "command": "git status {{-s|--short}}" }, { "description": "Show output in short format along with branch info", "command": "git status {{-sb|--short --branch}}" }, { "description": "Show the changes in staged files (like `git diff --cached`)", "command": "git status {{-v|--verbose}}" }, { "description": "Show the changes in all tracked files (like `git diff HEAD`)", "command": "git status {{-vv|--verbose --verbose}}" }, { "description": "Show the number of entries currently stashed away", "command": "git status --show-stash" }, { "description": "Don't show untracked files in the output", "command": "git status {{-uno|--untracked-files=no}}" } ], "tldr_source": "official", "flags": [ { "flag": "-s", "long": "--short", "arg": null, "description": "Give the output in the short-format." }, { "flag": "-b", "long": "--branch", "arg": null, "description": "Show the branch and tracking info even in short-format." }, { "flag": "", "long": "--show-stash", "arg": null, "description": "Show the number of entries currently stashed away. --porcelain[=] Give the output in an easy-to-parse format for scripts. This is similar to the short output, but will remain stable across Git versions and regardless of user configuration. See below for details. The version parameter is used to specify the format version. This is optional and defaults to the original version v1 format." }, { "flag": "", "long": "--long", "arg": null, "description": "Give the output in the long-format. This is the default." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "In addition to the names of files that have been changed, also show the textual changes that are staged to be committed (i.e., like the output of git diff --cached). If -v is specified twice, then also show the changes in the working tree that have not yet been staged (i.e., like the output of git diff). -u[], --untracked-files[=] Show untracked files. The mode parameter is used to specify the handling of untracked files. It is optional: it defaults to all, and if specified, it must be stuck to the option (e.g. -uno, but not -u no). The possible options are: • no - Show no untracked files. • normal - Shows untracked files and directories. • all - Also shows individual files in untracked directories. When -u option is not used, untracked files and directories are shown (i.e. the same as specifying normal), to help you avoid forgetting to add newly created files. Because it takes extra work to find untracked files in the filesystem, this mode may take some time in a large working tree. Consider enabling untracked cache and split index if supported (see git update-index --untracked-cache and git update-index --split-index), Otherwise you can use no to have git status return more quickly without showing untracked files. The default can be changed using the status.showUntrackedFiles configuration variable documented in git-config(1). --ignore-submodules[=] Ignore changes to submodules when looking for changes. can be either \"none\", \"untracked\", \"dirty\" or \"all\", which is the default. Using \"none\" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the ignore option in git-config(1) or gitmodules(5). When \"untracked\" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content). Using \"dirty\" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior before 1.7.0). Using \"all\" hides all changes to submodules (and suppresses the output of submodule summaries when the config option status.submoduleSummary is set). --ignored[=] Show ignored files as well. The mode parameter is used to specify the handling of ignored files. It is optional: it defaults to traditional. The possible options are: • traditional - Shows ignored files and directories, unless --untracked-files=all is specified, in which case individual files in ignored directories are displayed. • no - Show no ignored files. • matching - Shows ignored files and directories matching an ignore pattern. When matching mode is specified, paths that explicitly match an ignored pattern are shown. If a directory matches an ignore pattern, then it is shown, but not paths contained in the ignored directory. If a directory does not match an ignore pattern, but all contents are ignored, then the directory is not shown, but all contents are shown." }, { "flag": "-z", "long": null, "arg": null, "description": "Terminate entries with NUL, instead of LF. This implies the --porcelain=v1 output format if no other format is given. --column[=], --no-column Display untracked files in columns. See configuration variable column.status for option syntax. --column and --no-column without options are equivalent to always and never respectively." }, { "flag": "", "long": "--no-ahead-behind", "arg": null, "description": "Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch. Defaults to true." }, { "flag": "", "long": "--no-renames", "arg": null, "description": "Turn on/off rename detection regardless of user configuration. See also git-diff(1) --no-renames. --find-renames[=] Turn on rename detection, optionally setting the similarity threshold. See also git- diff(1) --find-renames. ... See the pathspec entry in gitglossary(7)." } ], "examples": [], "see_also": [ { "name": "gitignore", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/gitignore/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 6, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-s, --short", "lines": 2, "flag": "-s", "long": "--short" }, { "name": "-b, --branch", "lines": 2, "flag": "-b", "long": "--branch" }, { "name": "--show-stash", "lines": 10, "long": "--show-stash" }, { "name": "--long", "lines": 2, "long": "--long" }, { "name": "-v, --verbose", "lines": 63, "flag": "-v", "long": "--verbose" }, { "name": "-z", "lines": 8, "flag": "-z" }, { "name": "--ahead-behind, --no-ahead-behind", "lines": 3, "long": "--no-ahead-behind" }, { "name": "--renames, --no-renames", "lines": 10, "long": "--no-renames" } ] }, { "name": "OUTPUT", "lines": 8, "subsections": [ { "name": "Short Format", "lines": 89 }, { "name": "Porcelain Format Version 1", "lines": 20 }, { "name": "Porcelain Format Version 2", "lines": 6 }, { "name": "Branch Headers", "lines": 12 }, { "name": "Changed Tracked Entries", "lines": 64 }, { "name": "Other Items", "lines": 11 }, { "name": "Pathname Format Notes and -z", "lines": 6 } ] }, { "name": "CONFIGURATION", "lines": 16, "subsections": [] }, { "name": "BACKGROUND REFRESH", "lines": 8, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "GIT", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "git-status - Show the working tree status\n", "subsections": [] }, "SYNOPSIS": { "content": "git status [...] [--] [...]\n\n", "subsections": [] }, "DESCRIPTION": { "content": "Displays paths that have differences between the index file and the current HEAD commit,\npaths that have differences between the working tree and the index file, and paths in the\nworking tree that are not tracked by Git (and are not ignored by gitignore(5)). The first are\nwhat you would commit by running git commit; the second and third are what you could commit\nby running git add before running git commit.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-s, --short", "content": "Give the output in the short-format.\n", "flag": "-s", "long": "--short" }, { "name": "-b, --branch", "content": "Show the branch and tracking info even in short-format.\n", "flag": "-b", "long": "--branch" }, { "name": "--show-stash", "content": "Show the number of entries currently stashed away.\n\n--porcelain[=]\nGive the output in an easy-to-parse format for scripts. This is similar to the short\noutput, but will remain stable across Git versions and regardless of user configuration.\nSee below for details.\n\nThe version parameter is used to specify the format version. This is optional and\ndefaults to the original version v1 format.\n", "long": "--show-stash" }, { "name": "--long", "content": "Give the output in the long-format. This is the default.\n", "long": "--long" }, { "name": "-v, --verbose", "content": "In addition to the names of files that have been changed, also show the textual changes\nthat are staged to be committed (i.e., like the output of git diff --cached). If -v is\nspecified twice, then also show the changes in the working tree that have not yet been\nstaged (i.e., like the output of git diff).\n\n-u[], --untracked-files[=]\nShow untracked files.\n\nThe mode parameter is used to specify the handling of untracked files. It is optional: it\ndefaults to all, and if specified, it must be stuck to the option (e.g. -uno, but not -u\nno).\n\nThe possible options are:\n\n• no - Show no untracked files.\n\n• normal - Shows untracked files and directories.\n\n• all - Also shows individual files in untracked directories.\n\nWhen -u option is not used, untracked files and directories are shown (i.e. the same as\nspecifying normal), to help you avoid forgetting to add newly created files. Because it\ntakes extra work to find untracked files in the filesystem, this mode may take some time\nin a large working tree. Consider enabling untracked cache and split index if supported\n(see git update-index --untracked-cache and git update-index --split-index), Otherwise\nyou can use no to have git status return more quickly without showing untracked files.\n\nThe default can be changed using the status.showUntrackedFiles configuration variable\ndocumented in git-config(1).\n\n--ignore-submodules[=]\nIgnore changes to submodules when looking for changes. can be either \"none\",\n\"untracked\", \"dirty\" or \"all\", which is the default. Using \"none\" will consider the\nsubmodule modified when it either contains untracked or modified files or its HEAD\ndiffers from the commit recorded in the superproject and can be used to override any\nsettings of the ignore option in git-config(1) or gitmodules(5). When \"untracked\" is used\nsubmodules are not considered dirty when they only contain untracked content (but they\nare still scanned for modified content). Using \"dirty\" ignores all changes to the work\ntree of submodules, only changes to the commits stored in the superproject are shown\n(this was the behavior before 1.7.0). Using \"all\" hides all changes to submodules (and\nsuppresses the output of submodule summaries when the config option\nstatus.submoduleSummary is set).\n\n--ignored[=]\nShow ignored files as well.\n\nThe mode parameter is used to specify the handling of ignored files. It is optional: it\ndefaults to traditional.\n\nThe possible options are:\n\n• traditional - Shows ignored files and directories, unless --untracked-files=all is\nspecified, in which case individual files in ignored directories are displayed.\n\n• no - Show no ignored files.\n\n• matching - Shows ignored files and directories matching an ignore pattern.\n\nWhen matching mode is specified, paths that explicitly match an ignored pattern are\nshown. If a directory matches an ignore pattern, then it is shown, but not paths\ncontained in the ignored directory. If a directory does not match an ignore pattern, but\nall contents are ignored, then the directory is not shown, but all contents are shown.\n", "flag": "-v", "long": "--verbose" }, { "name": "-z", "content": "Terminate entries with NUL, instead of LF. This implies the --porcelain=v1 output format\nif no other format is given.\n\n--column[=], --no-column\nDisplay untracked files in columns. See configuration variable column.status for option\nsyntax. --column and --no-column without options are equivalent to always and never\nrespectively.\n", "flag": "-z" }, { "name": "--ahead-behind, --no-ahead-behind", "content": "Display or do not display detailed ahead/behind counts for the branch relative to its\nupstream branch. Defaults to true.\n", "long": "--no-ahead-behind" }, { "name": "--renames, --no-renames", "content": "Turn on/off rename detection regardless of user configuration. See also git-diff(1)\n--no-renames.\n\n--find-renames[=]\nTurn on rename detection, optionally setting the similarity threshold. See also git-\ndiff(1) --find-renames.\n\n...\nSee the pathspec entry in gitglossary(7).\n", "long": "--no-renames" } ] }, "OUTPUT": { "content": "The output from this command is designed to be used as a commit template comment. The\ndefault, long format, is designed to be human readable, verbose and descriptive. Its contents\nand format are subject to change at any time.\n\nThe paths mentioned in the output, unlike many other Git commands, are made relative to the\ncurrent directory if you are working in a subdirectory (this is on purpose, to help cutting\nand pasting). See the status.relativePaths config option below.\n", "subsections": [ { "name": "Short Format", "content": "In the short-format, the status of each path is shown as one of these forms\n\nXY PATH\nXY ORIGPATH -> PATH\n\nwhere ORIGPATH is where the renamed/copied contents came from. ORIGPATH is only shown when\nthe entry is renamed or copied. The XY is a two-letter status code.\n\nThe fields (including the ->) are separated from each other by a single space. If a filename\ncontains whitespace or other nonprintable characters, that field will be quoted in the manner\nof a C string literal: surrounded by ASCII double quote (34) characters, and with interior\nspecial characters backslash-escaped.\n\nThere are three different types of states that are shown using this format, and each one uses\nthe XY syntax differently:\n\n• When a merge is occurring and the merge was successful, or outside of a merge situation,\nX shows the status of the index and Y shows the status of the working tree.\n\n• When a merge conflict has occurred and has not yet been resolved, X and Y show the state\nintroduced by each head of the merge, relative to the common ancestor. These paths are\nsaid to be unmerged.\n\n• When a path is untracked, X and Y are always the same, since they are unknown to the\nindex. ?? is used for untracked paths. Ignored files are not listed unless --ignored is\nused; if it is, ignored files are indicated by !!.\n\nNote that the term merge here also includes rebases using the default --merge strategy,\ncherry-picks, and anything else using the merge machinery.\n\nIn the following table, these three classes are shown in separate sections, and these\ncharacters are used for X and Y fields for the first two sections that show tracked paths:\n\n• ' ' = unmodified\n\n• M = modified\n\n• T = file type changed (regular file, symbolic link or submodule)\n\n• A = added\n\n• D = deleted\n\n• R = renamed\n\n• C = copied (if config option status.renames is set to \"copies\")\n\n• U = updated but unmerged\n\nX Y Meaning\n-------------------------------------------------\n[AMD] not updated\nM [ MTD] updated in index\nT [ MTD] type changed in index\nA [ MTD] added to index\nD deleted from index\nR [ MTD] renamed in index\nC [ MTD] copied in index\n[MTARC] index and work tree matches\n[ MTARC] M work tree changed since index\n[ MTARC] T type changed in work tree since index\n[ MTARC] D deleted in work tree\nR renamed in work tree\nC copied in work tree\n-------------------------------------------------\nD D unmerged, both deleted\nA U unmerged, added by us\nU D unmerged, deleted by them\nU A unmerged, added by them\nD U unmerged, deleted by us\nA A unmerged, both added\nU U unmerged, both modified\n-------------------------------------------------\n? ? untracked\n! ! ignored\n-------------------------------------------------\n\nSubmodules have more state and instead report M the submodule has a different HEAD than\nrecorded in the index m the submodule has modified content ? the submodule has untracked\nfiles since modified content or untracked files in a submodule cannot be added via git add in\nthe superproject to prepare a commit.\n\nm and ? are applied recursively. For example if a nested submodule in a submodule contains an\nuntracked file, this is reported as ? as well.\n\nIf -b is used the short-format status is preceded by a line\n\n## branchname tracking info\n" }, { "name": "Porcelain Format Version 1", "content": "Version 1 porcelain format is similar to the short format, but is guaranteed not to change in\na backwards-incompatible way between Git versions or based on user configuration. This makes\nit ideal for parsing by scripts. The description of the short format above also describes the\nporcelain format, with a few exceptions:\n\n1. The user’s color.status configuration is not respected; color will always be off.\n\n2. The user’s status.relativePaths configuration is not respected; paths shown will always\nbe relative to the repository root.\n\nThere is also an alternate -z format recommended for machine parsing. In that format, the\nstatus field is the same, but some other things change. First, the -> is omitted from rename\nentries and the field order is reversed (e.g from -> to becomes to from). Second, a NUL\n(ASCII 0) follows each filename, replacing space as a field separator and the terminating\nnewline (but a space still separates the status field from the first filename). Third,\nfilenames containing special characters are not specially formatted; no quoting or\nbackslash-escaping is performed.\n\nAny submodule changes are reported as modified M instead of m or single ?.\n" }, { "name": "Porcelain Format Version 2", "content": "Version 2 format adds more detailed information about the state of the worktree and changed\nitems. Version 2 also defines an extensible set of easy to parse optional headers.\n\nHeader lines start with \"#\" and are added in response to specific command line arguments.\nParsers should ignore headers they don’t recognize.\n" }, { "name": "Branch Headers", "content": "If --branch is given, a series of header lines are printed with information about the\ncurrent branch.\n\nLine Notes\n------------------------------------------------------------\n# branch.oid | (initial) Current commit.\n# branch.head | (detached) Current branch.\n# branch.upstream If upstream is set.\n# branch.ab + - If upstream is set and\nthe commit is present.\n------------------------------------------------------------\n" }, { "name": "Changed Tracked Entries", "content": "Following the headers, a series of lines are printed for tracked entries. One of three\ndifferent line formats may be used to describe an entry depending on the type of change.\nTracked entries are printed in an undefined order; parsers should allow for a mixture of\nthe 3 line types in any order.\n\nOrdinary changed entries have the following format:\n\n1 \n\nRenamed or copied entries have the following format:\n\n2 \n\nField Meaning\n--------------------------------------------------------\n A 2 character field containing the staged and\nunstaged XY values described in the short format,\nwith unchanged indicated by a \".\" rather than\na space.\n A 4 character field describing the submodule state.\n\"N...\" when the entry is not a submodule.\n\"S\" when the entry is a submodule.\n is \"C\" if the commit changed; otherwise \".\".\n is \"M\" if it has tracked changes; otherwise \".\".\n is \"U\" if there are untracked changes; otherwise \".\".\n The octal file mode in HEAD.\n The octal file mode in the index.\n The octal file mode in the worktree.\n The object name in HEAD.\n The object name in the index.\n The rename or copy score (denoting the percentage\nof similarity between the source and target of the\nmove or copy). For example \"R100\" or \"C75\".\n The pathname. In a renamed/copied entry, this\nis the target path.\n When the `-z` option is used, the 2 pathnames are separated\nwith a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)\nbyte separates them.\n The pathname in the commit at HEAD or in the index.\nThis is only present in a renamed/copied entry, and\ntells where the renamed/copied contents came from.\n--------------------------------------------------------\n\nUnmerged entries have the following format; the first character is a \"u\" to distinguish\nfrom ordinary changed entries.\n\nu

\n\nField Meaning\n--------------------------------------------------------\n A 2 character field describing the conflict type\nas described in the short format.\n A 4 character field describing the submodule state\nas described above.\n The octal file mode in stage 1.\n The octal file mode in stage 2.\n The octal file mode in stage 3.\n The octal file mode in the worktree.\n

The object name in stage 1.\n

The object name in stage 2.\n

The object name in stage 3.\n The pathname.\n--------------------------------------------------------\n" }, { "name": "Other Items", "content": "Following the tracked entries (and if requested), a series of lines will be printed for\nuntracked and then ignored items found in the worktree.\n\nUntracked items have the following format:\n\n? \n\nIgnored items have the following format:\n\n! \n" }, { "name": "Pathname Format Notes and -z", "content": "When the -z option is given, pathnames are printed as is and without any quoting and\nlines are terminated with a NUL (ASCII 0x00) byte.\n\nWithout the -z option, pathnames with \"unusual\" characters are quoted as explained for\nthe configuration variable core.quotePath (see git-config(1)).\n" } ] }, "CONFIGURATION": { "content": "The command honors color.status (or status.color — they mean the same thing and the latter is\nkept for backward compatibility) and color.status. configuration variables to colorize\nits output.\n\nIf the config variable status.relativePaths is set to false, then all paths shown are\nrelative to the repository root, not to the current directory.\n\nIf status.submoduleSummary is set to a non zero number or true (identical to -1 or an\nunlimited number), the submodule summary will be enabled for the long format and a summary of\ncommits for modified submodules will be shown (see --summary-limit option of git-\nsubmodule(1)). Please note that the summary output from the status command will be suppressed\nfor all submodules when diff.ignoreSubmodules is set to all or only for those submodules\nwhere submodule..ignore=all. To also view the summary for ignored submodules you can\neither use the --ignore-submodules=dirty command line option or the git submodule summary\ncommand, which shows a similar output but does not honor these settings.\n", "subsections": [] }, "BACKGROUND REFRESH": { "content": "By default, git status will automatically refresh the index, updating the cached stat\ninformation from the working tree and writing out the result. Writing out the updated index\nis an optimization that isn’t strictly necessary (status computes the values for itself, but\nwriting them out is just to save subsequent programs from repeating our computation). When\nstatus is run in the background, the lock held during the write may conflict with other\nsimultaneous processes, causing them to fail. Scripts running status in the background should\nconsider using git --no-optional-locks status (see git(1) for details).\n", "subsections": [] }, "SEE ALSO": { "content": "gitignore(5)\n", "subsections": [] }, "GIT": { "content": "Part of the git(1) suite\n\n\n\nGit 2.34.1 02/26/2026 GIT-STATUS(1)", "subsections": [] } } } }