gritHEAD → docs/cat
Commands / PlumbingMarkdown

grit cat

Show blob, tree, commit, or tag contents for a revision spec.

grit cat <SPEC>

Description

Shows the contents of the object named by a revision spec:

  • Blob — raw bytes written to stdout (no extra framing). Large blobs stream from the object database with bounded memory.
  • Tree — one line per entry like git cat-file -p (six-digit directory modes such as 040000, then a type word from the mode bits, oid, tab, path — same rule as Git, without reading each entry's object).
  • Commit or tag — the canonical object payload (same bytes as git cat-file -p).

Object bytes and metadata honor refs/replace the same way as Git (unless GIT_NO_REPLACE_OBJECTS is set). Supported specs are the same as grit resolve: peeled tips, rev:path, short oids, and reflog selectors.

Options

Option Description
<SPEC> Object or revision spec to display (required).

JSON output

Schema: v1

Pass --json for stable, scripting-friendly output:

Field Type Meaning
warnings array Non-fatal warnings while resolving or reading.
spec string Input spec.
oid string Resolved object id (full hex).
kind string blob, tree, commit, or tag.
size number Uncompressed object size in bytes.
content object Tagged payload; shape depends on kind.
content.kind string Discriminator: blob, tree, commit, or tag.
content.encoding string For blobs: utf-8 or base64.
content.text string UTF-8 blob or commit/tag body when applicable.
content.data_base64 string Blob bytes when not UTF-8 (omitted when the blob is ≥ 1 MiB).
content.omitted_inline boolean When true, the blob is too large to embed; human mode streams bytes to stdout.
content.entries array Tree lines with mode, type, oid, and path.

Blobs of at least 1 MiB omit both text and data_base64 and set omitted_inline to true. Use human output redirected to a file to retrieve their bytes. Commit and tag payloads remain inline regardless of size.

Markdown output

Schema: v1

Pass --markdown for a short summary and a fenced block (or table for trees) of the object contents. Binary blobs are summarized in Markdown; use --json for base64 payloads smaller than 1 MiB. Larger blobs include metadata and an omission notice.

Exit status

Code Meaning
0 Success (success).
1 Command failed (failure).
2 Invalid flags or arguments (usage).

See Exit codes for shared rules and structured --json kind values.