đź“ť Edit page
âž• Add page
status
Usage
Short help:
$ git status -h
usage: git status [<options>] [--] <pathspec>...
-v, --verbose be verbose
-s, --short show status concisely
-b, --branch show branch information
--show-stash show stash information
--ahead-behind compute full ahead/behind values
--porcelain[=<version>]
machine-readable output
--long show status in long format (default)
-z, --null terminate entries with NUL
-u, --untracked-files[=<mode>]
show untracked files, optional modes: all, normal, no. (Default: all)
--ignored[=<mode>] show ignored files, optional modes: traditional, matching, no. (Default: traditional)
--ignore-submodules[=<when>]
ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)
--column[=<style>] list untracked files in columns
--no-renames do not detect renames
-M, --find-renames[=<n>]
detect renames, optionally set similarity index
Flags
Some flags I am interested in. From the long help.
-s, --short
Give the output in the short-format.
(Default is --long)
-b, --branch
Show the branch and tracking info even in short-format.
--show-stash
Show the number of entries currently stashed away.
--porcelain[=<version>]
Give the output in an easy-to-parse format for scripts. This is similar to the short output, but
will remain stable across Git versions and regardless of user configuration. See below for details.
The version parameter is used to specify the format version. This is optional and defaults to the
original version v1 format.
...
(This makes output without color for safety. Using with no arguments is OK.)
-v, --verbose
In addition to the names of files that have been changed, also show the textual changes that are
staged to be committed (i.e., like the output of git diff --cached). If -v is specified twice, then
also show the changes in the working tree that have not yet been staged (i.e., like the output of
git diff).
--find-renames[=<n>]
Turn on rename detection, optionally setting the similarity threshold. See also git-diff(1)
--find-renames.
Using verbose will show the lines changed including of lines of staged files (even if new at the bottom.
Short format
From Short format in the docs.
In the short-format, the status of each path is shown as one of these forms
XY PATH
XY ORIG_PATH -> PATH
There are rules for merge conflicts in the doc.
Untracked files are:
?? PATH
Here are the rules for remaining cases:
' ' = unmodified
M = modified
A = added
D = deleted
R = renamed
C = copied
U = updated but unmerged
Ignored files are not listed, unless –ignored option is in effect, in which case XY are !!.
Further details:
X Y Meaning
-------------------------------------------------
[AMD] not updated
M [ MD] updated in index
A [ MD] added to index
D deleted from index
R [ MD] renamed in index
C [ MD] copied in index
[MARC] index and work tree matches
[ MARC] M work tree changed since index
[ MARC] D deleted in work tree
[ D] R renamed in work tree
[ D] C copied in work tree
-------------------------------------------------
D D unmerged, both deleted
A U unmerged, added by us
U D unmerged, deleted by them
U A unmerged, added by them
D U unmerged, deleted by us
A A unmerged, both added
U U unmerged, both modified
-------------------------------------------------
? ? untracked
! ! ignored
-------------------------------------------------
Parse output
Use for scripting and git hooks.
This will show a short summary (-s), ignore untracked (using untracked=no but note equals sign won’t work) and porcelain for clean, parseable output without colors.
$ git status -s -uno --porcelain
-s --short
-u[<mode>], --untracked-files[=<mode>]
Show untracked files.
...
The possible options are:
• no - Show no untracked files.
• normal - Shows untracked files and directories.
• all - Also shows individual files in untracked directories.
--porcelain
Give the output in an easy-to-parse format for scripts. This is similar to the short
output, but will remain stable across Git versions and regardless of user
configuration.
Z format
As an alternative to porcelain.
This means that R foo -> bar becomes R bar\0foo\0.
From the man page:
There is also an alternate -z format recommended for machine parsing. In that format, the status field is the same, but
some other things change. First, the -> is omitted from rename entries and the field order is reversed (e.g from -> to
becomes to from). Second, a NUL (ASCII 0) follows each filename, replacing space as a field separator and the terminating
newline (but a space still separates the status field from the first filename). Third, filenames containing special
characters are not specially formatted; no quoting or backslash-escaping is performed.
Conditional logic
Check for unstaged modified files
Check if repo is clean or dirty (unstaged changes to be committed still).
Using porcelain
Check if there are unstaged changes.
if [ -z "$(git status --porcelain)" ]; then
echo 'No changes to commit'
fi
Using grep
The ZSH way of doing it - article.
INDEX=$(git status 2> /dev/null)
if $(echo "$INDEX" | grep 'Untracked files' &> /dev/null); then
echo 'There are untracked files'
fi
if $(echo "$INDEX" | grep -E -e 'Changes not staged' &> /dev/null); then
echo 'Unstaged changes'
fi
This is then used conditionally to determine when these should be used.
ZSH_THEME_GIT_PROMPT_DIRTY="%{$fg[green]%}!"
ZSH_THEME_GIT_PROMPT_UNTRACKED="%{$fg[green]%}?"
Format length style
Long format
The default.
$ git status
On branch master
Your branch is up to date with 'origin/master'.
Changes not staged for commit:
(use "git add/rm <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
deleted: Makefile
Untracked files:
(use "git add <file>..." to include in what will be committed)
test.text
no changes added to commit (use "git add" and/or "git commit -a")
Short output
$ git status -s
e.g.
D Makefile
?? test.text