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