git-cat-file - Provide content or type and size information for repository objects
git cat-file <type> <object>
git cat-file (-e | -p) <object>
git cat-file (-t | -s) [--allow-unknown-type] <object>
git cat-file (--batch | --batch-check | --batch-command) [--batch-all-objects]
[--buffer] [--follow-symlinks] [--unordered]
[--textconv | --filters] [-Z]
git cat-file (--textconv | --filters)
[<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>]
In its first form, the command provides the content or the type of an object in the repository. The type is required unless -t
or -p
is used to find the object type, or -s
is used to find the object size, or --textconv
or --filters
is used (which imply type "blob").
In the second form, a list of objects (separated by linefeeds) is provided on stdin, and the SHA-1, type, and size of each object is printed on stdout. The output format can be overridden using the optional <format>
argument. If either --textconv
or --filters
was specified, the input is expected to list the object names followed by the path name, separated by a single whitespace, so that the appropriate drivers can be determined.
If -t
is specified, one of the <type>
.
If -s
is specified, the size of the <object>
in bytes.
If -e
is specified, no output, unless the <object>
is malformed.
If -p
is specified, the contents of <object>
are pretty-printed.
If <type>
is specified, the raw (though uncompressed) contents of the <object>
will be returned.
If --batch
or --batch-check
is given, cat-file
will read objects from stdin, one per line, and print information about them. By default, the whole line is considered as an object, as if it were fed to git-rev-parse[1].
When --batch-command
is given, cat-file
will read commands from stdin, one per line, and print information based on the command given. With --batch-command
, the info
command followed by an object will print information about the object the same way --batch-check
would, and the contents
command followed by an object prints contents in the same way --batch
would.
You can specify the information shown for each object by using a custom <format>
. The <format>
is copied literally to stdout for each object, with placeholders of the form %(atom)
expanded, followed by a newline. The available atoms are:
-
objectname
-
The full hex representation of the object name.
-
objecttype
-
The type of the object (the same as cat-file -t
reports).
-
objectsize
-
The size, in bytes, of the object (the same as cat-file -s
reports).
-
objectsize:disk
-
The size, in bytes, that the object takes up on disk. See the note about on-disk sizes in the CAVEATS
section below.
-
deltabase
-
If the object is stored as a delta on-disk, this expands to the full hex representation of the delta base object name. Otherwise, expands to the null OID (all zeroes). See CAVEATS
below.
-
rest
-
If this atom is used in the output string, input lines are split at the first whitespace boundary. All characters before that whitespace are considered to be the object name; characters after that first run of whitespace (i.e., the "rest" of the line) are output in place of the %(rest)
atom.
If no format is specified, the default format is %(objectname)
%(objecttype) %(objectsize)
.
If --batch
is specified, or if --batch-command
is used with the contents
command, the object information is followed by the object contents (consisting of %(objectsize)
bytes), followed by a newline.
For example, --batch
without a custom format would produce:
<oid> SP <type> SP <size> LF
<contents> LF
Whereas --batch-check='%(objectname) %(objecttype)'
would produce:
If a name is specified on stdin that cannot be resolved to an object in the repository, then cat-file
will ignore any custom format and print:
If a name is specified that might refer to more than one object (an ambiguous short sha), then cat-file
will ignore any custom format and print:
If --follow-symlinks
is used, and a symlink in the repository points outside the repository, then cat-file
will ignore any custom format and print:
symlink SP <size> LF
<symlink> LF
The symlink will either be absolute (beginning with a /
), or relative to the tree root. For instance, if dir/link points to ../../foo
, then <symlink>
will be ../foo
. <size>
is the size of the symlink in bytes.
If --follow-symlinks
is used, the following error messages will be displayed:
is printed when the initial symlink requested does not exist.
dangling SP <size> LF
<object> LF
is printed when the initial symlink exists, but something that it (transitive-of) points to does not.
loop SP <size> LF
<object> LF
is printed for symlink loops (or any symlinks that require more than 40 link resolutions to resolve).
notdir SP <size> LF
<object> LF
is printed when, during symlink resolution, a file is used as a directory name.
Alternatively, when -Z
is passed, the line feeds in any of the above examples are replaced with NUL terminators. This ensures that output will be parsable if the output itself would contain a linefeed and is thus recommended for scripting purposes.
Note that the sizes of objects on disk are reported accurately, but care should be taken in drawing conclusions about which refs or objects are responsible for disk usage. The size of a packed non-delta object may be much larger than the size of objects which delta against it, but the choice of which object is the base and which is the delta is arbitrary and is subject to change during a repack.
Note also that multiple copies of an object may be present in the object database; in this case, it is undefined which copy’s size or delta base will be reported.