1git-status(1) 2============= 3 4NAME 5---- 6git-status - Show the working tree status 7 8 9SYNOPSIS 10-------- 11[verse] 12'git status' [<options>...] [--] [<pathspec>...] 13 14DESCRIPTION 15----------- 16Displays paths that have differences between the index file and the 17current HEAD commit, paths that have differences between the working 18tree and the index file, and paths in the working tree that are not 19tracked by Git (and are not ignored by linkgit:gitignore[5]). The first 20are what you _would_ commit by running `git commit`; the second and 21third are what you _could_ commit by running 'git add' before running 22`git commit`. 23 24OPTIONS 25------- 26 27-s:: 28--short:: 29 Give the output in the short-format. 30 31-b:: 32--branch:: 33 Show the branch and tracking info even in short-format. 34 35--show-stash:: 36 Show the number of entries currently stashed away. 37 38--porcelain[=<version>]:: 39 Give the output in an easy-to-parse format for scripts. 40 This is similar to the short output, but will remain stable 41 across Git versions and regardless of user configuration. See 42 below for details. 43+ 44The version parameter is used to specify the format version. 45This is optional and defaults to the original version 'v1' format. 46 47--long:: 48 Give the output in the long-format. This is the default. 49 50-v:: 51--verbose:: 52 In addition to the names of files that have been changed, also 53 show the textual changes that are staged to be committed 54 (i.e., like the output of `git diff --cached`). If `-v` is specified 55 twice, then also show the changes in the working tree that 56 have not yet been staged (i.e., like the output of `git diff`). 57 58-u[<mode>]:: 59--untracked-files[=<mode>]:: 60 Show untracked files. 61+ 62The mode parameter is used to specify the handling of untracked files. 63It is optional: it defaults to 'all', and if specified, it must be 64stuck to the option (e.g. `-uno`, but not `-u no`). 65+ 66The possible options are: 67+ 68 - 'no' - Show no untracked files. 69 - 'normal' - Shows untracked files and directories. 70 - 'all' - Also shows individual files in untracked directories. 71+ 72When `-u` option is not used, untracked files and directories are 73shown (i.e. the same as specifying `normal`), to help you avoid 74forgetting to add newly created files. Because it takes extra work 75to find untracked files in the filesystem, this mode may take some 76time in a large working tree. 77Consider enabling untracked cache and split index if supported (see 78`git update-index --untracked-cache` and `git update-index 79--split-index`), Otherwise you can use `no` to have `git status` 80return more quickly without showing untracked files. 81+ 82The default can be changed using the status.showUntrackedFiles 83configuration variable documented in linkgit:git-config[1]. 84 85--ignore-submodules[=<when>]:: 86 Ignore changes to submodules when looking for changes. <when> can be 87 either "none", "untracked", "dirty" or "all", which is the default. 88 Using "none" will consider the submodule modified when it either contains 89 untracked or modified files or its HEAD differs from the commit recorded 90 in the superproject and can be used to override any settings of the 91 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When 92 "untracked" is used submodules are not considered dirty when they only 93 contain untracked content (but they are still scanned for modified 94 content). Using "dirty" ignores all changes to the work tree of submodules, 95 only changes to the commits stored in the superproject are shown (this was 96 the behavior before 1.7.0). Using "all" hides all changes to submodules 97 (and suppresses the output of submodule summaries when the config option 98 `status.submoduleSummary` is set). 99 100--ignored[=<mode>]:: 101 Show ignored files as well. 102+ 103The mode parameter is used to specify the handling of ignored files. 104It is optional: it defaults to 'traditional'. 105+ 106The possible options are: 107+ 108 - 'traditional' - Shows ignored files and directories, unless 109 --untracked-files=all is specifed, in which case 110 individual files in ignored directories are 111 displayed. 112 - 'no' - Show no ignored files. 113 - 'matching' - Shows ignored files and directories matching an 114 ignore pattern. 115+ 116When 'matching' mode is specified, paths that explicity match an 117ignored pattern are shown. If a directory matches an ignore pattern, 118then it is shown, but not paths contained in the ignored directory. If 119a directory does not match an ignore pattern, but all contents are 120ignored, then the directory is not shown, but all contents are shown. 121 122-z:: 123 Terminate entries with NUL, instead of LF. This implies 124 the `--porcelain=v1` output format if no other format is given. 125 126--column[=<options>]:: 127--no-column:: 128 Display untracked files in columns. See configuration variable 129 column.status for option syntax.`--column` and `--no-column` 130 without options are equivalent to 'always' and 'never' 131 respectively. 132 133<pathspec>...:: 134 See the 'pathspec' entry in linkgit:gitglossary[7]. 135 136OUTPUT 137------ 138The output from this command is designed to be used as a commit 139template comment. 140The default, long format, is designed to be human readable, 141verbose and descriptive. Its contents and format are subject to change 142at any time. 143 144The paths mentioned in the output, unlike many other Git commands, are 145made relative to the current directory if you are working in a 146subdirectory (this is on purpose, to help cutting and pasting). See 147the status.relativePaths config option below. 148 149Short Format 150~~~~~~~~~~~~ 151 152In the short-format, the status of each path is shown as 153 154 XY PATH1 -> PATH2 155 156where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is 157shown only when `PATH1` corresponds to a different path in the 158index/worktree (i.e. the file is renamed). The `XY` is a two-letter 159status code. 160 161The fields (including the `->`) are separated from each other by a 162single space. If a filename contains whitespace or other nonprintable 163characters, that field will be quoted in the manner of a C string 164literal: surrounded by ASCII double quote (34) characters, and with 165interior special characters backslash-escaped. 166 167For paths with merge conflicts, `X` and `Y` show the modification 168states of each side of the merge. For paths that do not have merge 169conflicts, `X` shows the status of the index, and `Y` shows the status 170of the work tree. For untracked paths, `XY` are `??`. Other status 171codes can be interpreted as follows: 172 173* ' ' = unmodified 174* 'M' = modified 175* 'A' = added 176* 'D' = deleted 177* 'R' = renamed 178* 'C' = copied 179* 'U' = updated but unmerged 180 181Ignored files are not listed, unless `--ignored` option is in effect, 182in which case `XY` are `!!`. 183 184 X Y Meaning 185 ------------------------------------------------- 186 [MD] not updated 187 M [ MD] updated in index 188 A [ MD] added to index 189 D [ M] deleted from index 190 R [ MD] renamed in index 191 C [ MD] copied in index 192 [MARC] index and work tree matches 193 [ MARC] M work tree changed since index 194 [ MARC] D deleted in work tree 195 ------------------------------------------------- 196 D D unmerged, both deleted 197 A U unmerged, added by us 198 U D unmerged, deleted by them 199 U A unmerged, added by them 200 D U unmerged, deleted by us 201 A A unmerged, both added 202 U U unmerged, both modified 203 ------------------------------------------------- 204 ? ? untracked 205 ! ! ignored 206 ------------------------------------------------- 207 208Submodules have more state and instead report 209 M the submodule has a different HEAD than 210 recorded in the index 211 m the submodule has modified content 212 ? the submodule has untracked files 213since modified content or untracked files in a submodule cannot be added 214via `git add` in the superproject to prepare a commit. 215 216'm' and '?' are applied recursively. For example if a nested submodule 217in a submodule contains an untracked file, this is reported as '?' as well. 218 219If -b is used the short-format status is preceded by a line 220 221 ## branchname tracking info 222 223Porcelain Format Version 1 224~~~~~~~~~~~~~~~~~~~~~~~~~~ 225 226Version 1 porcelain format is similar to the short format, but is guaranteed 227not to change in a backwards-incompatible way between Git versions or 228based on user configuration. This makes it ideal for parsing by scripts. 229The description of the short format above also describes the porcelain 230format, with a few exceptions: 231 2321. The user's color.status configuration is not respected; color will 233 always be off. 234 2352. The user's status.relativePaths configuration is not respected; paths 236 shown will always be relative to the repository root. 237 238There is also an alternate -z format recommended for machine parsing. In 239that format, the status field is the same, but some other things 240change. First, the '\->' is omitted from rename entries and the field 241order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL 242(ASCII 0) follows each filename, replacing space as a field separator 243and the terminating newline (but a space still separates the status 244field from the first filename). Third, filenames containing special 245characters are not specially formatted; no quoting or 246backslash-escaping is performed. 247 248Any submodule changes are reported as modified `M` instead of `m` or single `?`. 249 250Porcelain Format Version 2 251~~~~~~~~~~~~~~~~~~~~~~~~~~ 252 253Version 2 format adds more detailed information about the state of 254the worktree and changed items. Version 2 also defines an extensible 255set of easy to parse optional headers. 256 257Header lines start with "#" and are added in response to specific 258command line arguments. Parsers should ignore headers they 259don't recognize. 260 261### Branch Headers 262 263If `--branch` is given, a series of header lines are printed with 264information about the current branch. 265 266 Line Notes 267 ------------------------------------------------------------ 268 # branch.oid <commit> | (initial) Current commit. 269 # branch.head <branch> | (detached) Current branch. 270 # branch.upstream <upstream_branch> If upstream is set. 271 # branch.ab +<ahead> -<behind> If upstream is set and 272 the commit is present. 273 ------------------------------------------------------------ 274 275### Changed Tracked Entries 276 277Following the headers, a series of lines are printed for tracked 278entries. One of three different line formats may be used to describe 279an entry depending on the type of change. Tracked entries are printed 280in an undefined order; parsers should allow for a mixture of the 3 281line types in any order. 282 283Ordinary changed entries have the following format: 284 285 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path> 286 287Renamed or copied entries have the following format: 288 289 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath> 290 291 Field Meaning 292 -------------------------------------------------------- 293 <XY> A 2 character field containing the staged and 294 unstaged XY values described in the short format, 295 with unchanged indicated by a "." rather than 296 a space. 297 <sub> A 4 character field describing the submodule state. 298 "N..." when the entry is not a submodule. 299 "S<c><m><u>" when the entry is a submodule. 300 <c> is "C" if the commit changed; otherwise ".". 301 <m> is "M" if it has tracked changes; otherwise ".". 302 <u> is "U" if there are untracked changes; otherwise ".". 303 <mH> The octal file mode in HEAD. 304 <mI> The octal file mode in the index. 305 <mW> The octal file mode in the worktree. 306 <hH> The object name in HEAD. 307 <hI> The object name in the index. 308 <X><score> The rename or copy score (denoting the percentage 309 of similarity between the source and target of the 310 move or copy). For example "R100" or "C75". 311 <path> The pathname. In a renamed/copied entry, this 312 is the path in the index and in the working tree. 313 <sep> When the `-z` option is used, the 2 pathnames are separated 314 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09) 315 byte separates them. 316 <origPath> The pathname in the commit at HEAD. This is only 317 present in a renamed/copied entry, and tells 318 where the renamed/copied contents came from. 319 -------------------------------------------------------- 320 321Unmerged entries have the following format; the first character is 322a "u" to distinguish from ordinary changed entries. 323 324 u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path> 325 326 Field Meaning 327 -------------------------------------------------------- 328 <XY> A 2 character field describing the conflict type 329 as described in the short format. 330 <sub> A 4 character field describing the submodule state 331 as described above. 332 <m1> The octal file mode in stage 1. 333 <m2> The octal file mode in stage 2. 334 <m3> The octal file mode in stage 3. 335 <mW> The octal file mode in the worktree. 336 <h1> The object name in stage 1. 337 <h2> The object name in stage 2. 338 <h3> The object name in stage 3. 339 <path> The pathname. 340 -------------------------------------------------------- 341 342### Other Items 343 344Following the tracked entries (and if requested), a series of 345lines will be printed for untracked and then ignored items 346found in the worktree. 347 348Untracked items have the following format: 349 350 ? <path> 351 352Ignored items have the following format: 353 354 ! <path> 355 356### Pathname Format Notes and -z 357 358When the `-z` option is given, pathnames are printed as is and 359without any quoting and lines are terminated with a NUL (ASCII 0x00) 360byte. 361 362Without the `-z` option, pathnames with "unusual" characters are 363quoted as explained for the configuration variable `core.quotePath` 364(see linkgit:git-config[1]). 365 366 367CONFIGURATION 368------------- 369 370The command honors `color.status` (or `status.color` -- they 371mean the same thing and the latter is kept for backward 372compatibility) and `color.status.<slot>` configuration variables 373to colorize its output. 374 375If the config variable `status.relativePaths` is set to false, then all 376paths shown are relative to the repository root, not to the current 377directory. 378 379If `status.submoduleSummary` is set to a non zero number or true (identical 380to -1 or an unlimited number), the submodule summary will be enabled for 381the long format and a summary of commits for modified submodules will be 382shown (see --summary-limit option of linkgit:git-submodule[1]). Please note 383that the summary output from the status command will be suppressed for all 384submodules when `diff.ignoreSubmodules` is set to 'all' or only for those 385submodules where `submodule.<name>.ignore=all`. To also view the summary for 386ignored submodules you can either use the --ignore-submodules=dirty command 387line option or the 'git submodule summary' command, which shows a similar 388output but does not honor these settings. 389 390BACKGROUND REFRESH 391------------------ 392 393By default, `git status` will automatically refresh the index, updating 394the cached stat information from the working tree and writing out the 395result. Writing out the updated index is an optimization that isn't 396strictly necessary (`status` computes the values for itself, but writing 397them out is just to save subsequent programs from repeating our 398computation). When `status` is run in the background, the lock held 399during the write may conflict with other simultaneous processes, causing 400them to fail. Scripts running `status` in the background should consider 401using `git --no-optional-locks status` (see linkgit:git[1] for details). 402 403SEE ALSO 404-------- 405linkgit:gitignore[5] 406 407GIT 408--- 409Part of the linkgit:git[1] suite