6 git-status - Show the working tree status
12 'git status' [<options>...] [--] [<pathspec>...]
16 Displays paths that have differences between the index file and the
17 current HEAD commit, paths that have differences between the working
18 tree and the index file, and paths in the working tree that are not
19 tracked by git (and are not ignored by linkgit:gitignore[5]). The first
20 are what you _would_ commit by running `git commit`; the second and
21 third are what you _could_ commit by running 'git add' before running
29 Give the output in the short-format.
33 Show the branch and tracking info even in short-format.
36 Give the output in an easy-to-parse format for scripts.
37 This is similar to the short output, but will remain stable
38 across git versions and regardless of user configuration. See
42 --untracked-files[=<mode>]::
45 The mode parameter is optional (defaults to 'all'), and is used to
46 specify the handling of untracked files.
48 The possible options are:
50 - 'no' - Show no untracked files.
51 - 'normal' - Shows untracked files and directories.
52 - 'all' - Also shows individual files in untracked directories.
54 When `-u` option is not used, untracked files and directories are
55 shown (i.e. the same as specifying `normal`), to help you avoid
56 forgetting to add newly created files. Because it takes extra work
57 to find untracked files in the filesystem, this mode may take some
58 time in a large working tree. You can use `no` to have `git status`
59 return more quickly without showing untracked files.
61 The default can be changed using the status.showUntrackedFiles
62 configuration variable documented in linkgit:git-config[1].
64 --ignore-submodules[=<when>]::
65 Ignore changes to submodules when looking for changes. <when> can be
66 either "none", "untracked", "dirty" or "all", which is the default.
67 Using "none" will consider the submodule modified when it either contains
68 untracked or modified files or its HEAD differs from the commit recorded
69 in the superproject and can be used to override any settings of the
70 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
71 "untracked" is used submodules are not considered dirty when they only
72 contain untracked content (but they are still scanned for modified
73 content). Using "dirty" ignores all changes to the work tree of submodules,
74 only changes to the commits stored in the superproject are shown (this was
75 the behavior before 1.7.0). Using "all" hides all changes to submodules
76 (and suppresses the output of submodule summaries when the config option
77 `status.submodulesummary` is set).
80 Show ignored files as well.
83 Terminate entries with NUL, instead of LF. This implies
84 the `--porcelain` output format if no other format is given.
86 --column[=<options>]::
88 Display untracked files in columns. See configuration variable
89 column.status for option syntax.`--column` and `--no-column`
90 without options are equivalent to 'always' and 'never'
96 The output from this command is designed to be used as a commit
97 template comment, and all the output lines are prefixed with '#'.
98 The default, long format, is designed to be human readable,
99 verbose and descriptive. Its contents and format are subject to change
102 The paths mentioned in the output, unlike many other git commands, are
103 made relative to the current directory if you are working in a
104 subdirectory (this is on purpose, to help cutting and pasting). See
105 the status.relativePaths config option below.
110 In the short-format, the status of each path is shown as
114 where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
115 shown only when `PATH1` corresponds to a different path in the
116 index/worktree (i.e. the file is renamed). The 'XY' is a two-letter
119 The fields (including the `->`) are separated from each other by a
120 single space. If a filename contains whitespace or other nonprintable
121 characters, that field will be quoted in the manner of a C string
122 literal: surrounded by ASCII double quote (34) characters, and with
123 interior special characters backslash-escaped.
125 For paths with merge conflicts, `X` and 'Y' show the modification
126 states of each side of the merge. For paths that do not have merge
127 conflicts, `X` shows the status of the index, and `Y` shows the status
128 of the work tree. For untracked paths, `XY` are `??`. Other status
129 codes can be interpreted as follows:
137 * 'U' = updated but unmerged
139 Ignored files are not listed, unless `--ignored` option is in effect,
140 in which case `XY` are `!!`.
143 -------------------------------------------------
145 M [ MD] updated in index
146 A [ MD] added to index
147 D [ M] deleted from index
148 R [ MD] renamed in index
149 C [ MD] copied in index
150 [MARC] index and work tree matches
151 [ MARC] M work tree changed since index
152 [ MARC] D deleted in work tree
153 -------------------------------------------------
154 D D unmerged, both deleted
155 A U unmerged, added by us
156 U D unmerged, deleted by them
157 U A unmerged, added by them
158 D U unmerged, deleted by us
159 A A unmerged, both added
160 U U unmerged, both modified
161 -------------------------------------------------
164 -------------------------------------------------
166 If -b is used the short-format status is preceded by a line
168 ## branchname tracking info
173 The porcelain format is similar to the short format, but is guaranteed
174 not to change in a backwards-incompatible way between git versions or
175 based on user configuration. This makes it ideal for parsing by scripts.
176 The description of the short format above also describes the porcelain
177 format, with a few exceptions:
179 1. The user's color.status configuration is not respected; color will
182 2. The user's status.relativePaths configuration is not respected; paths
183 shown will always be relative to the repository root.
185 There is also an alternate -z format recommended for machine parsing. In
186 that format, the status field is the same, but some other things
187 change. First, the '\->' is omitted from rename entries and the field
188 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
189 (ASCII 0) follows each filename, replacing space as a field separator
190 and the terminating newline (but a space still separates the status
191 field from the first filename). Third, filenames containing special
192 characters are not specially formatted; no quoting or
193 backslash-escaping is performed.
198 The command honors `color.status` (or `status.color` -- they
199 mean the same thing and the latter is kept for backward
200 compatibility) and `color.status.<slot>` configuration variables
201 to colorize its output.
203 If the config variable `status.relativePaths` is set to false, then all
204 paths shown are relative to the repository root, not to the current
207 If `status.submodulesummary` is set to a non zero number or true (identical
208 to -1 or an unlimited number), the submodule summary will be enabled for
209 the long format and a summary of commits for modified submodules will be
210 shown (see --summary-limit option of linkgit:git-submodule[1]).
218 Part of the linkgit:git[1] suite