8 releases (4 breaking)
|new 0.5.0||Aug 19, 2018|
|0.4.1||May 31, 2018|
|0.3.0||May 8, 2018|
|0.2.3||May 3, 2018|
|0.1.0||Apr 22, 2018|
#21 in Command line utilities
519 downloads per month
bat supports syntax highlighting for a large number of programming and markup
bat communicates with
git to show modifications with respect to the index
(see left side bar):
bat can pipe its own output to
less if the output is too large for one screen.
Oh.. you can also use it to concatenate files :wink:. Whenever
bat detects a non-interactive terminal, it will fall back to printing
the plain file contents.
Display a single file on the terminal
> bat README.md
Display multiple files at once
> bat src/*.rs
Read from stdin, explicitly specify the language
> yaml2json .travis.yml | json_pp | bat -l json
> curl -s https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs | bat -l rs
As a replacement for
bat > note.md # quickly create a new file bat header.md content.md footer.md > document.md bat -n main.rs # show line numbers (only) bat f - g # output 'f', then stdin, then 'g'.
Check out the Release page for binary builds and Debian packages.
You can install via Pacman:
pacman -S bat
You can install a precompiled
bat package with pkg:
pkg install bat
or build it on your own from the FreeBSD ports:
cd /usr/ports/textproc/bat make install
You can install
bat with Homebrew:
brew install bat
If you want to build to compile
bat from source, you need Rust 1.26 or
higher. You can then use
cargo to build everything:
cargo install bat
On macOS, you might have to install
brew install cmake) in order for
some dependencies to be built.
bat --list-themes to get a list of all available themes for syntax
highlighting. To select the
TwoDark theme, call
bat with the
--theme=TwoDark option or set the
BAT_THEME environment variable to
export BAT_THEME="TwoDark" in your shells startup file to
make the change permanent.
You can use the
--style option to control the appearance of
You can use
--style=numbers,changes, for example, to show only Git changes
and line numbers but no grid and no file header.
Create a folder with syntax definition files:
BAT_CONFIG_DIR="$(bat cache --config-dir)" mkdir -p "$BAT_CONFIG_DIR/syntaxes" cd "$BAT_CONFIG_DIR/syntaxes" # Put new '.sublime-syntax' language definition files # in this folder (or its subdirectories), for example: git clone https://github.com/tellnobody1/sublime-purescript-syntax
Now use the following command to parse these files into a binary cache:
bat cache --init
bat --list-languages to check if the new languages are available.
If you ever want to go back to the default settings, call:
bat cache --clear
This works very similar to how we add new syntax definitions.
First, create a folder with the new syntax highlighting themes:
BAT_CONFIG_DIR="$(bat cache --config-dir)" mkdir -p "$BAT_CONFIG_DIR/themes" cd "$BAT_CONFIG_DIR/themes" # Download a theme in '.tmTheme' format, for example: git clone https://github.com/greggb/sublime-snazzy # Create a link to specify the new default theme ln -sf "sublime-snazzy/Sublime Snazzy.tmTheme" Default.tmTheme # Update the binary cache bat cache --init
bat --list-themes to check if the new themes are available.
Note: Unlike for syntax definitions, adding custom themes currently removes all default
themes. If you want to go back to the default themes, call
bat cache --clear.
bat uses the pager that is specified in the
PAGER environment variable. If this variable is not
less is used by default. If you want to use a different pager, you can either modify the
PAGER variable or set the
BAT_PAGER environment variable to override what is specified in
PAGER. If you want to pass command-line arguments to the pager, you need to create a small shell
script as a wrapper, for example:
#!/bin/bash less --tabs 4 -RF "$@"
bat tries to achieve the following goals:
- Provide beautiful, advanced syntax highlighting
- Integrate with Git to show file modifications
- Be a drop-in replacement for (POSIX)
- Offer a user-friendly command-line interface
There are a lot of alternatives, if you are looking for similar programs. See this document for a comparison.
- ansi_term 0.11
- atty 0.2.2
+suggestions +color +wrap_help
- console 0.6
- directories 1.0
- error-chain 0.12
- git2 0.7
- lazy_static 1.0
+parsing +yaml-load +dump-load +dump-create
- dev tempdir 0.3