← All commands
THE COMMAND REFERENCE

bat

Show files with syntax highlighting, line numbers and paging.

Last updated

Portable / common

Implementation-level reference; examples are not certified for every installed version.

Overview

bat prints files like cat, but at a terminal it adds syntax highlighting, line numbers and a frame, and pages long files. When its output goes into a pipe or a file it prints the plain text only, so it can replace cat without changing scripts. It also marks lines changed since the last git commit.

Background

bat is an open-source tool whose manual is in its repository. It is a separate program from cat and is installed on request. The tool tested here is bat 0.26.1.

Examples

Print a file without any decoration, with -p (plain):

printf 'one\ntwo\n' > f.txt && bat -p f.txt

Show line numbers; the option --decorations=always keeps them even when the output is a pipe:

printf 'one\ntwo\n' > f.txt && bat --decorations=always --style=numbers f.txt

Say which language to highlight with -l, for text that has no file name:

echo '{"a":1}' | bat -l json --style=plain

Show only a line range with -r:

printf 'one\ntwo\nthree\n' > f.txt && bat -p -r 2:2 f.txt

Options

-p
Plain: no line numbers, no frame.

-l
Set the language used for highlighting.

--style
Choose which decorations to show, such as numbers, grid or plain.

-r
Print only this line range, as in -r 10:20.

Common mistakes

When output goes to a pipe bat behaves like cat, which is good for scripts, but it can look as if the options do nothing; add --decorations=always to force them. On Debian and Ubuntu the command is named batcat because bat was already taken. Its pager is less; press q to quit. Do not use bat for binary files you want to see unchanged: it shows them with escapes.

Portability

bat is a different program from cat, so options such as -A and -s do not mean what they do in cat. The examples were executed on bat 0.26.1. The Common examples were executed on bat 0.26.1 (see the development guide for the exact check).

References

Original explanations, with upstream documentation for further reading. FreeBSD references are comparison material, not a claim of Apple version equivalence.