Setup and Config
Getting and Creating Projects
Basic Snapshotting
Branching and Merging
Sharing and Updating Projects
Inspection and Comparison
Patching
Debugging
External Systems
Server Admin
Guides
- gitattributes
- Command-line interface conventions
- Everyday Git
- Frequently Asked Questions (FAQ)
- Glossary
- Hooks
- gitignore
- gitmodules
- Revisions
- Submodules
- Tutorial
- Workflows
- All guides...
Administration
Plumbing Commands
-
2.56.0
2026-09-28
- 2.53.0 → 2.55.0 no changes
-
2.52.0
2025-11-17
-
2.51.2
2025-10-27
- 2.45.4 → 2.51.1 no changes
-
2.45.3
2024-11-26
- 2.45.1 → 2.45.2 no changes
-
2.45.0
2024-04-29
- 2.44.1 → 2.44.4 no changes
-
2.44.0
2024-02-23
- 2.43.1 → 2.43.7 no changes
-
2.43.0
2023-11-20
- 2.42.1 → 2.42.4 no changes
-
2.42.0
2023-08-21
- 2.41.1 → 2.41.3 no changes
-
2.41.0
2023-06-01
- 2.39.4 → 2.40.4 no changes
-
2.39.3
2023-04-17
- 2.39.1 → 2.39.2 no changes
-
2.39.0
2022-12-12
- 2.37.3 → 2.38.5 no changes
-
2.37.2
2022-08-11
- 2.33.1 → 2.37.1 no changes
-
2.33.0
2021-08-16
- 2.31.1 → 2.32.7 no changes
-
2.31.0
2021-03-15
- 2.30.1 → 2.30.9 no changes
-
2.30.0
2020-12-27
- 2.29.1 → 2.29.3 no changes
-
2.29.0
2020-10-19
- 2.27.1 → 2.28.1 no changes
-
2.27.0
2020-06-01
- 2.25.1 → 2.26.3 no changes
-
2.25.0
2020-01-13
- 2.23.1 → 2.24.4 no changes
-
2.23.0
2019-08-16
- 2.22.1 → 2.22.5 no changes
-
2.22.0
2019-06-07
- 2.19.1 → 2.21.4 no changes
-
2.19.0
2018-09-10
- 2.18.1 → 2.18.5 no changes
-
2.18.0
2018-06-21
- 2.17.0 → 2.17.6 no changes
-
2.16.6
2019-12-06
-
2.15.4
2019-12-06
- 2.14.6 no changes
-
2.13.7
2018-05-22
-
2.12.5
2017-09-22
-
2.11.4
2017-09-22
-
2.10.5
2017-09-22
-
2.9.5
2017-07-30
-
2.8.6
2017-07-30
- 2.6.7 → 2.7.6 no changes
-
2.5.6
2017-05-05
-
2.4.12
2017-05-05
- 2.3.10 no changes
-
2.2.3
2015-09-04
-
2.1.4
2014-12-17
-
2.0.5
2014-12-17
DESCRIPTION
Many Git porcelainish commands take a mixture of flags (i.e. parameters that begin with a dash -) and parameters meant for the underlying git rev-list command they use internally and flags and parameters for the other commands they use downstream of git rev-list. The primary purpose of this command is to allow calling programs to distinguish between them. There are a few other operation modes that have nothing to do with the above "help parse command line options".
Unless otherwise specified, most of the options and operation modes require you to run this command inside a git repository or a working tree that is under the control of a git repository, and will give you a fatal error otherwise.
OPTIONS
Operation Modes
Each of these options must appear first on the command line.
- --parseopt
-
Use git rev-parse in option parsing mode (see PARSEOPT section below). The command in this mode can be used outside a repository or a working tree controlled by a repository.
- --sq-quote
-
Use git rev-parse in shell quoting mode (see SQ-QUOTE section below). In contrast to the
--sqoption below, this mode only does quoting. Nothing else is done to command input. The command in this mode can be used outside a repository or a working tree controlled by a repository.
Options for --parseopt
- --keep-dashdash
-
Only meaningful in
--parseoptmode. Tells the option parser to echo out the first--met instead of skipping it. - --stop-at-non-option
-
Only meaningful in
--parseoptmode. Lets the option parser stop at the first non-option argument. This can be used to parse sub-commands that take options themselves. - --stuck-long
-
Only meaningful in
--parseoptmode. Output the options in their long form if available, and with their arguments stuck.
Options for Output
- --default <arg>
-
If there is no parameter given by the user, use <arg> instead.
- --prefix <arg>
-
Behave as if git rev-parse was invoked from the <arg> subdirectory of the working tree. Any relative filenames are resolved as if they are prefixed by <arg> and will be printed in that form.
This can be used to convert arguments to a command run in a subdirectory so that they can still be used after moving to the top-level of the repository. For example:
prefix=$(git rev-parse --show-prefix) cd "$(git rev-parse --show-toplevel)" # rev-parse provides the -- needed for 'set' eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
- --verify
-
Verify that exactly one parameter is provided, and that it can be turned into a raw 20-byte SHA-1 that can be used to access the object database. If so, emit it to the standard output; otherwise, error out.
If you want to make sure that the output actually names an object in your object database and/or can be used as a specific type of object you require, you can add the
^{type}peeling operator to the parameter. For example,gitrev-parse"$VAR^{commit}"will make sure$VARnames an existing object that is a commit-ish (i.e. a commit, or an annotated tag that points at a commit). To make sure that$VARnames an existing object of any type,gitrev-parse"$VAR^{object}"can be used.Note that if you are verifying a name from an untrusted source, it is wise to use
--end-of-optionsso that the name argument is not mistaken for another option. - -q
- --quiet
-
Only meaningful in
--verifymode. Do not output an error message if the first argument is not a valid object name; instead exit with non-zero status silently. SHA-1s for valid object names are printed to stdout on success. - --sq
-
Usually the output is made one line per flag and parameter. This option makes output a single line, properly quoted for consumption by shell. Useful when you expect your parameter to contain whitespaces and newlines (e.g. when using pickaxe
-Swith git diff-*). In contrast to the--sq-quoteoption, the command input is still interpreted as usual. - --short[=<length>]
-
Same as
--verifybut shortens the object name to a unique prefix with at leastlengthcharacters. The minimum length is 4, the default is the effective value of thecore.abbrevconfiguration variable (see git-config[1]). - --not
-
When showing object names, prefix them with ^ and strip ^ prefix from the object names that already have one.
- --abbrev-ref[=(strict|loose)]
-
A non-ambiguous short name of the objects name. The option core.warnAmbiguousRefs is used to select the strict abbreviation mode.
- --symbolic
-
Usually the object names are output in SHA-1 form (with possible ^ prefix); this option makes them output in a form as close to the original input as possible.
- --symbolic-full-name
-
This is similar to --symbolic, but it omits input that are not refs (i.e. branch or tag names; or more explicitly disambiguating "heads/master" form, when you want to name the "master" branch when there is an unfortunately named tag "master"), and shows them as full refnames (e.g. "refs/heads/master").
- --output-object-format=(sha1|sha256|storage)
-
Allow oids to be input from any object format that the current repository supports.
Specifying "sha1" translates if necessary and returns a sha1 oid.
Specifying "sha256" translates if necessary and returns a sha256 oid.
Specifying "storage" translates if necessary and returns an oid in encoded in the storage hash algorithm.
Options for Objects
- --all
-
Show all refs found in
refs/. - --branches[=<pattern>]
- --tags[=<pattern>]
- --remotes[=<pattern>]
-
Show all branches, tags, or remote-tracking branches, respectively (i.e., refs found in
refs/heads,refs/tags, orrefs/remotes, respectively).If a
patternis given, only refs matching the given shell glob are shown. If the pattern does not contain a globbing character (?,*, or [), it is turned into a prefix match by appending/*. - --glob=<pattern>
-
Show all refs matching the shell glob pattern
pattern. If the pattern does not start withrefs/, this is automatically prepended. If the pattern does not contain a globbing character (?,*, or [), it is turned into a prefix match by appending/*. - --exclude=<glob-pattern>
-
Do not include refs matching <glob-pattern> that the next
--all,--branches,--tags,--remotes, or--globwould otherwise consider. Repetitions of this option accumulate exclusion patterns up to the next--all,--branches,--tags,--remotes, or--globoption (other options or arguments do not clear accumulated patterns).The patterns given should not begin with
refs/heads,refs/tags, orrefs/remoteswhen applied to