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 one of these 153forms 154 155 XY PATH 156 XY ORIG_PATH -> PATH 157 158where `ORIG_PATH` is where the renamed/copied contents came 159from. `ORIG_PATH` is only shown when the entry is renamed or 160copied. The `XY` is a two-letter status code. 161 162The fields (including the `->`) are separated from each other by a 163single space. If a filename contains whitespace or other nonprintable 164characters, that field will be quoted in the manner of a C string 165literal: surrounded by ASCII double quote (34) characters, and with 166interior special characters backslash-escaped. 167 168For paths with merge conflicts, `X` and `Y` show the modification 169states of each side of the merge. For paths that do not have merge 170conflicts, `X` shows the status of the index, and `Y` shows the status 171of the work tree. For untracked paths, `XY` are `??`. Other status 172codes can be interpreted as follows: 173 174* ' ' = unmodified 175* 'M' = modified 176* 'A' = added 177* 'D' = deleted 178* 'R' = renamed 179* 'C' = copied 180* 'U' = updated but unmerged 181 182Ignored files are not listed, unless `--ignored` option is in effect, 183in which case `XY` are `!!`. 184 185 X Y Meaning 186 ------------------------------------------------- 187 [MD] not updated 188 M [ MD] updated in index 189 A [ MD] added to index 190 D [ M] deleted from index 191 R [ MD] renamed in index 192 C [ MD] copied in index 193 [MARC] index and work tree matches 194 [ MARC] M work tree changed since index 195 [ MARC] D deleted in work tree 196 [ D] R renamed in work tree 197 [ D] C copied in work tree 198 ------------------------------------------------- 199 D D unmerged, both deleted 200 A U unmerged, added by us 201 U D unmerged, deleted by them 202 U A unmerged, added by them 203 D U unmerged, deleted by us 204 A A unmerged, both added 205 U U unmerged, both modified 206 ------------------------------------------------- 207 ? ? untracked 208 ! ! ignored 209 ------------------------------------------------- 210 211Submodules have more state and instead report 212 M the submodule has a different HEAD than 213 recorded in the index 214 m the submodule has modified content 215 ? the submodule has untracked files 216since modified content or untracked files in a submodule cannot be added 217via `git add` in the superproject to prepare a commit. 218 219'm' and '?' are applied recursively. For example if a nested submodule 220in a submodule contains an untracked file, this is reported as '?' as well. 221 222If -b is used the short-format status is preceded by a line 223 224 ## branchname tracking info 225 226Porcelain Format Version 1 227~~~~~~~~~~~~~~~~~~~~~~~~~~ 228 229Version 1 porcelain format is similar to the short format, but is guaranteed 230not to change in a backwards-incompatible way between Git versions or 231based on user configuration. This makes it ideal for parsing by scripts. 232The description of the short format above also describes the porcelain 233format, with a few exceptions: 234 2351. The user's color.status configuration is not respected; color will 236 always be off. 237 2382. The user's status.relativePaths configuration is not respected; paths 239 shown will always be relative to the repository root. 240 241There is also an alternate -z format recommended for machine parsing. In 242that format, the status field is the same, but some other things 243change. First, the '\->' is omitted from rename entries and the field 244order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL 245(ASCII 0) follows each filename, replacing space as a field separator 246and the terminating newline (but a space still separates the status 247field from the first filename). Third, filenames containing special 248characters are not specially formatted; no quoting or 249backslash-escaping is performed. 250 251Any submodule changes are reported as modified `M` instead of `m` or single `?`. 252 253Porcelain Format Version 2 254~~~~~~~~~~~~~~~~~~~~~~~~~~ 255 256Version 2 format adds more detailed information about the state of 257the worktree and changed items. Version 2 also defines an extensible 258set of easy to parse optional headers. 259 260Header lines start with "#" and are added in response to specific 261command line arguments. Parsers should ignore headers they 262don't recognize. 263 264### Branch Headers 265 266If `--branch` is given, a series of header lines are printed with 267information about the current branch. 268 269 Line Notes 270 ------------------------------------------------------------ 271 # branch.oid <commit> | (initial) Current commit. 272 # branch.head <branch> | (detached) Current branch. 273 # branch.upstream <upstream_branch> If upstream is set. 274 # branch.ab +<ahead> -<behind> If upstream is set and 275 the commit is present. 276 ------------------------------------------------------------ 277 278### Changed Tracked Entries 279 280Following the headers, a series of lines are printed for tracked 281entries. One of three different line formats may be used to describe 282an entry depending on the type of change. Tracked entries are printed 283in an undefined order; parsers should allow for a mixture of the 3 284line types in any order. 285 286Ordinary changed entries have the following format: 287 288 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path> 289 290Renamed or copied entries have the following format: 291 292 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath> 293 294 Field Meaning 295 -------------------------------------------------------- 296 <XY> A 2 character field containing the staged and 297 unstaged XY values described in the short format, 298 with unchanged indicated by a "." rather than 299 a space. 300 <sub> A 4 character field describing the submodule state. 301 "N..." when the entry is not a submodule. 302 "S<c><m><u>" when the entry is a submodule. 303 <c> is "C" if the commit changed; otherwise ".". 304 <m> is "M" if it has tracked changes; otherwise ".". 305 <u> is "U" if there are untracked changes; otherwise ".". 306 <mH> The octal file mode in HEAD. 307 <mI> The octal file mode in the index. 308 <mW> The octal file mode in the worktree. 309 <hH> The object name in HEAD. 310 <hI> The object name in the index. 311 <X><score> The rename or copy score (denoting the percentage 312 of similarity between the source and target of the 313 move or copy). For example "R100" or "C75". 314 <path> The pathname. In a renamed/copied entry, this 315 is the target path. 316 <sep> When the `-z` option is used, the 2 pathnames are separated 317 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09) 318 byte separates them. 319 <origPath> The pathname in the commit at HEAD or in the index. 320 This is only present in a renamed/copied entry, and 321 tells where the renamed/copied contents came from. 322 -------------------------------------------------------- 323 324Unmerged entries have the following format; the first character is 325a "u" to distinguish from ordinary changed entries. 326 327 u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path> 328 329 Field Meaning 330 -------------------------------------------------------- 331 <XY> A 2 character field describing the conflict type 332 as described in the short format. 333 <sub> A 4 character field describing the submodule state 334 as described above. 335 <m1> The octal file mode in stage 1. 336 <m2> The octal file mode in stage 2. 337 <m3> The octal file mode in stage 3. 338 <mW> The octal file mode in the worktree. 339 <h1> The object name in stage 1. 340 <h2> The object name in stage 2. 341 <h3> The object name in stage 3. 342 <path> The pathname. 343 -------------------------------------------------------- 344 345### Other Items 346 347Following the tracked entries (and if requested), a series of 348lines will be printed for untracked and then ignored items 349found in the worktree. 350 351Untracked items have the following format: 352 353 ? <path> 354 355Ignored items have the following format: 356 357 ! <path> 358 359### Pathname Format Notes and -z 360 361When the `-z` option is given, pathnames are printed as is and 362without any quoting and lines are terminated with a NUL (ASCII 0x00) 363byte. 364 365Without the `-z` option, pathnames with "unusual" characters are 366quoted as explained for the configuration variable `core.quotePath` 367(see linkgit:git-config[1]). 368 369 370CONFIGURATION 371------------- 372 373The command honors `color.status` (or `status.color` -- they 374mean the same thing and the latter is kept for backward 375compatibility) and `color.status.<slot>` configuration variables 376to colorize its output. 377 378If the config variable `status.relativePaths` is set to false, then all 379paths shown are relative to the repository root, not to the current 380directory. 381 382If `status.submoduleSummary` is set to a non zero number or true (identical 383to -1 or an unlimited number), the submodule summary will be enabled for 384the long format and a summary of commits for modified submodules will be 385shown (see --summary-limit option of linkgit:git-submodule[1]). Please note 386that the summary output from the status command will be suppressed for all 387submodules when `diff.ignoreSubmodules` is set to 'all' or only for those 388submodules where `submodule.<name>.ignore=all`. To also view the summary for 389ignored submodules you can either use the --ignore-submodules=dirty command 390line option or the 'git submodule summary' command, which shows a similar 391output but does not honor these settings. 392 393BACKGROUND REFRESH 394------------------ 395 396By default, `git status` will automatically refresh the index, updating 397the cached stat information from the working tree and writing out the 398result. Writing out the updated index is an optimization that isn't 399strictly necessary (`status` computes the values for itself, but writing 400them out is just to save subsequent programs from repeating our 401computation). When `status` is run in the background, the lock held 402during the write may conflict with other simultaneous processes, causing 403them to fail. Scripts running `status` in the background should consider 404using `git --no-optional-locks status` (see linkgit:git[1] for details). 405 406SEE ALSO 407-------- 408linkgit:gitignore[5] 409 410GIT 411--- 412Part of the linkgit:git[1] suite