Documentation/git-cat-file.txt

   1 git-cat-file(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-cat-file - Provide content or type and size information for repository objects
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git cat-file' (-t [--allow-unknown-type]| -s [--allow-unknown-type]| -e | -p | <type> | --textconv ) <object>
  13 'git cat-file' (--batch | --batch-check) < <list-of-objects>
  14
  15 DESCRIPTION
  16 -----------
  17 In its first form, the command provides the content or the type of an object in
  18 the repository. The type is required unless '-t' or '-p' is used to find the
  19 object type, or '-s' is used to find the object size, or '--textconv' is used
  20 (which implies type "blob").
  21
  22 In the second form, a list of objects (separated by linefeeds) is provided on
  23 stdin, and the SHA-1, type, and size of each object is printed on stdout.
  24
  25 OPTIONS
  26 -------
  27 <object>::
  28         The name of the object to show.
  29         For a more complete list of ways to spell object names, see
  30         the "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
  31
  32 -t::
  33         Instead of the content, show the object type identified by
  34         <object>.
  35
  36 -s::
  37         Instead of the content, show the object size identified by
  38         <object>.
  39
  40 -e::
  41         Suppress all output; instead exit with zero status if <object>
  42         exists and is a valid object.
  43
  44 -p::
  45         Pretty-print the contents of <object> based on its type.
  46
  47 <type>::
  48         Typically this matches the real type of <object> but asking
  49         for a type that can trivially be dereferenced from the given
  50         <object> is also permitted.  An example is to ask for a
  51         "tree" with <object> being a commit object that contains it,
  52         or to ask for a "blob" with <object> being a tag object that
  53         points at it.
  54
  55 --textconv::
  56         Show the content as transformed by a textconv filter. In this case,
  57         <object> has be of the form <tree-ish>:<path>, or :<path> in order
  58         to apply the filter to the content recorded in the index at <path>.
  59
  60 --batch::
  61 --batch=<format>::
  62         Print object information and contents for each object provided
  63         on stdin.  May not be combined with any other options or arguments.
  64         See the section `BATCH OUTPUT` below for details.
  65
  66 --batch-check::
  67 --batch-check=<format>::
  68         Print object information for each object provided on stdin.  May
  69         not be combined with any other options or arguments.  See the
  70         section `BATCH OUTPUT` below for details.
  71
  72 --allow-unknown-type::
  73         Allow -s or -t to query broken/corrupt objects of unknown type.
  74
  75 OUTPUT
  76 ------
  77 If '-t' is specified, one of the <type>.
  78
  79 If '-s' is specified, the size of the <object> in bytes.
  80
  81 If '-e' is specified, no output.
  82
  83 If '-p' is specified, the contents of <object> are pretty-printed.
  84
  85 If <type> is specified, the raw (though uncompressed) contents of the <object>
  86 will be returned.
  87
  88 BATCH OUTPUT
  89 ------------
  90
  91 If `--batch` or `--batch-check` is given, `cat-file` will read objects
  92 from stdin, one per line, and print information about them. By default,
  93 the whole line is considered as an object, as if it were fed to
  94 linkgit:git-rev-parse[1].
  95
  96 You can specify the information shown for each object by using a custom
  97 `<format>`. The `<format>` is copied literally to stdout for each
  98 object, with placeholders of the form `%(atom)` expanded, followed by a
  99 newline. The available atoms are:
 100
 101 `objectname`::
 102         The 40-hex object name of the object.
 103
 104 `objecttype`::
 105         The type of of the object (the same as `cat-file -t` reports).
 106
 107 `objectsize`::
 108         The size, in bytes, of the object (the same as `cat-file -s`
 109         reports).
 110
 111 `objectsize:disk`::
 112         The size, in bytes, that the object takes up on disk. See the
 113         note about on-disk sizes in the `CAVEATS` section below.
 114
 115 `deltabase`::
 116         If the object is stored as a delta on-disk, this expands to the
 117         40-hex sha1 of the delta base object. Otherwise, expands to the
 118         null sha1 (40 zeroes). See `CAVEATS` below.
 119
 120 `rest`::
 121         If this atom is used in the output string, input lines are split
 122         at the first whitespace boundary. All characters before that
 123         whitespace are considered to be the object name; characters
 124         after that first run of whitespace (i.e., the "rest" of the
 125         line) are output in place of the `%(rest)` atom.
 126
 127 If no format is specified, the default format is `%(objectname)
 128 %(objecttype) %(objectsize)`.
 129
 130 If `--batch` is specified, the object information is followed by the
 131 object contents (consisting of `%(objectsize)` bytes), followed by a
 132 newline.
 133
 134 For example, `--batch` without a custom format would produce:
 135
 136 ------------
 137 <sha1> SP <type> SP <size> LF
 138 <contents> LF
 139 ------------
 140
 141 Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:
 142
 143 ------------
 144 <sha1> SP <type> LF
 145 ------------
 146
 147 If a name is specified on stdin that cannot be resolved to an object in
 148 the repository, then `cat-file` will ignore any custom format and print:
 149
 150 ------------
 151 <object> SP missing LF
 152 ------------
 153
 154
 155 CAVEATS
 156 -------
 157
 158 Note that the sizes of objects on disk are reported accurately, but care
 159 should be taken in drawing conclusions about which refs or objects are
 160 responsible for disk usage. The size of a packed non-delta object may be
 161 much larger than the size of objects which delta against it, but the
 162 choice of which object is the base and which is the delta is arbitrary
 163 and is subject to change during a repack.
 164
 165 Note also that multiple copies of an object may be present in the object
 166 database; in this case, it is undefined which copy's size or delta base
 167 will be reported.
 168
 169 GIT
 170 ---
 171 Part of the linkgit:git[1] suite