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.
35 --porcelain[=<version>]::
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
41 The version parameter is used to specify the format version.
42 This is optional and defaults to the original version 'v1' format.
45 Give the output in the long-format. This is the default.
49 In addition to the names of files that have been changed, also
50 show the textual changes that are staged to be committed
51 (i.e., like the output of `git diff --cached`). If `-v` is specified
52 twice, then also show the changes in the working tree that
53 have not yet been staged (i.e., like the output of `git diff`).
56 --untracked-files[=<mode>]::
59 The mode parameter is used to specify the handling of untracked files.
60 It is optional: it defaults to 'all', and if specified, it must be
61 stuck to the option (e.g. `-uno`, but not `-u no`).
63 The possible options are:
65 - 'no' - Show no untracked files.
66 - 'normal' - Shows untracked files and directories.
67 - 'all' - Also shows individual files in untracked directories.
69 When `-u` option is not used, untracked files and directories are
70 shown (i.e. the same as specifying `normal`), to help you avoid
71 forgetting to add newly created files. Because it takes extra work
72 to find untracked files in the filesystem, this mode may take some
73 time in a large working tree.
74 Consider enabling untracked cache and split index if supported (see
75 `git update-index --untracked-cache` and `git update-index
76 --split-index`), Otherwise you can use `no` to have `git status`
77 return more quickly without showing untracked files.
79 The default can be changed using the status.showUntrackedFiles
80 configuration variable documented in linkgit:git-config[1].
82 --ignore-submodules[=<when>]::
83 Ignore changes to submodules when looking for changes. <when> can be
84 either "none", "untracked", "dirty" or "all", which is the default.
85 Using "none" will consider the submodule modified when it either contains
86 untracked or modified files or its HEAD differs from the commit recorded
87 in the superproject and can be used to override any settings of the
88 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
89 "untracked" is used submodules are not considered dirty when they only
90 contain untracked content (but they are still scanned for modified
91 content). Using "dirty" ignores all changes to the work tree of submodules,
92 only changes to the commits stored in the superproject are shown (this was
93 the behavior before 1.7.0). Using "all" hides all changes to submodules
94 (and suppresses the output of submodule summaries when the config option
95 `status.submoduleSummary` is set).
98 Show ignored files as well.
101 Terminate entries with NUL, instead of LF. This implies
102 the `--porcelain=v1` output format if no other format is given.
104 --column[=<options>]::
106 Display untracked files in columns. See configuration variable
107 column.status for option syntax.`--column` and `--no-column`
108 without options are equivalent to 'always' and 'never'
114 The output from this command is designed to be used as a commit
116 The default, long format, is designed to be human readable,
117 verbose and descriptive. Its contents and format are subject to change
120 The paths mentioned in the output, unlike many other Git commands, are
121 made relative to the current directory if you are working in a
122 subdirectory (this is on purpose, to help cutting and pasting). See
123 the status.relativePaths config option below.
128 In the short-format, the status of each path is shown as
132 where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
133 shown only when `PATH1` corresponds to a different path in the
134 index/worktree (i.e. the file is renamed). The `XY` is a two-letter
137 The fields (including the `->`) are separated from each other by a
138 single space. If a filename contains whitespace or other nonprintable
139 characters, that field will be quoted in the manner of a C string
140 literal: surrounded by ASCII double quote (34) characters, and with
141 interior special characters backslash-escaped.
143 For paths with merge conflicts, `X` and `Y` show the modification
144 states of each side of the merge. For paths that do not have merge
145 conflicts, `X` shows the status of the index, and `Y` shows the status
146 of the work tree. For untracked paths, `XY` are `??`. Other status
147 codes can be interpreted as follows:
155 * 'U' = updated but unmerged
157 Ignored files are not listed, unless `--ignored` option is in effect,
158 in which case `XY` are `!!`.
161 -------------------------------------------------
163 M [ MD] updated in index
164 A [ MD] added to index
165 D [ M] deleted from index
166 R [ MD] renamed in index
167 C [ MD] copied in index
168 [MARC] index and work tree matches
169 [ MARC] M work tree changed since index
170 [ MARC] D deleted in work tree
171 -------------------------------------------------
172 D D unmerged, both deleted
173 A U unmerged, added by us
174 U D unmerged, deleted by them
175 U A unmerged, added by them
176 D U unmerged, deleted by us
177 A A unmerged, both added
178 U U unmerged, both modified
179 -------------------------------------------------
182 -------------------------------------------------
184 If -b is used the short-format status is preceded by a line
186 ## branchname tracking info
191 The porcelain format is similar to the short format, but is guaranteed
192 not to change in a backwards-incompatible way between Git versions or
193 based on user configuration. This makes it ideal for parsing by scripts.
194 The description of the short format above also describes the porcelain
195 format, with a few exceptions:
197 1. The user's color.status configuration is not respected; color will
200 2. The user's status.relativePaths configuration is not respected; paths
201 shown will always be relative to the repository root.
203 There is also an alternate -z format recommended for machine parsing. In
204 that format, the status field is the same, but some other things
205 change. First, the '\->' is omitted from rename entries and the field
206 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
207 (ASCII 0) follows each filename, replacing space as a field separator
208 and the terminating newline (but a space still separates the status
209 field from the first filename). Third, filenames containing special
210 characters are not specially formatted; no quoting or
211 backslash-escaping is performed.
216 The command honors `color.status` (or `status.color` -- they
217 mean the same thing and the latter is kept for backward
218 compatibility) and `color.status.<slot>` configuration variables
219 to colorize its output.
221 If the config variable `status.relativePaths` is set to false, then all
222 paths shown are relative to the repository root, not to the current
225 If `status.submoduleSummary` is set to a non zero number or true (identical
226 to -1 or an unlimited number), the submodule summary will be enabled for
227 the long format and a summary of commits for modified submodules will be
228 shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
229 that the summary output from the status command will be suppressed for all
230 submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
231 submodules where `submodule.<name>.ignore=all`. To also view the summary for
232 ignored submodules you can either use the --ignore-submodules=dirty command
233 line option or the 'git submodule summary' command, which shows a similar
234 output but does not honor these settings.
242 Part of the linkgit:git[1] suite