Bat
A cat(1) clone with wings.
Install / Use
/learn @sharkdp/BatREADME
Sponsors
A special thank you goes to our biggest <a href="doc/sponsors.md">sponsors</a>:<br>
<p> <a href="https://www.warp.dev/bat"> <img src="doc/sponsors/warp-logo.png" width="200" alt="Warp"> <br> <strong>Warp, the intelligent terminal</strong> <br> <sub>Available on MacOS, Linux, Windows</sub> </a> </p>Syntax highlighting
bat supports syntax highlighting for a large number of programming and markup
languages:
Git integration
bat communicates with git to show modifications with respect to the index
(see left sidebar):
Show non-printable characters
You can use the -A/--show-all option to show and highlight non-printable
characters:
Automatic paging
By default, bat pipes its own output to a pager (e.g. less) if the output is too large for one screen.
If you would rather bat work like cat all the time (never page output), you can set --paging=never as an option, either on the command line or in your configuration file.
If you intend to alias cat to bat in your shell configuration, you can use alias cat='bat --paging=never' to preserve the default behavior.
File concatenation
Even with a pager set, you can still use bat to concatenate files :wink:.
Whenever bat detects a non-interactive terminal (i.e. when you pipe into another process or into a file), bat will act as a drop-in replacement for cat and fall back to printing the plain file contents, regardless of the --pager option's value.
How to use
Display a single file on the terminal
bat README.md
Display multiple files at once
bat src/*.rs
Read from stdin, determine the syntax automatically (note, highlighting will
only work if the syntax can be determined from the first line of the file,
usually through a shebang such as #!/bin/sh)
curl -s https://sh.rustup.rs | bat
Read from stdin, specify the language explicitly
yaml2json .travis.yml | json_pp | bat -l json
Show and highlight non-printable characters:
bat -A /etc/hosts
Use it as a cat replacement:
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'.
Integration with other tools
fzf
You can use bat as a previewer for fzf. To do this,
use bat's --color=always option to force colorized output. You can also use --line-range
option to restrict the load times for long files:
fzf --preview "bat --color=always --style=numbers --line-range=:500 {}"
For more information, see fzf's README.
find or fd
You can use the -exec option of find to preview all search results with bat:
find … -exec bat {} +
If you happen to use fd, you can use the -X/--exec-batch option to do the same:
fd … -X bat
ripgrep
With batgrep, bat can be used as the printer for ripgrep search results.
batgrep needle src/
tail -f
bat can be combined with tail -f to continuously monitor a given file with syntax highlighting.
tail -f /var/log/pacman.log | bat --paging=never -l log
Note that we have to switch off paging in order for this to work. We have also specified the syntax
explicitly (-l log), as it can not be auto-detected in this case.
git
You can combine bat with git show to view an older version of a given file with proper syntax
highlighting:
git show v0.6.0:src/main.rs | bat -l rs
git diff
You can combine bat with git diff to view lines around code changes with proper syntax
highlighting:
batdiff() {
git diff --name-only --relative --diff-filter=d -z | xargs -0 bat --diff
}
If you prefer to use this as a separate tool, check out batdiff in bat-extras.
If you are looking for more support for git and diff operations, check out delta.
xclip
The line numbers and Git modification markers in the output of bat can make it hard to copy
the contents of a file. To prevent this, you can call bat with the -p/--plain option or
simply pipe the output into xclip:
bat main.cpp | xclip
bat will detect that the output is being redirected and print the plain file contents.
man
bat can be used as a colorizing pager for man, by setting the
MANPAGER environment variable:
export MANPAGER="bat -plman"
man 2 select
(on some older Debian or Ubuntu releases, the executable is named batcat instead of bat)
If you prefer to have this bundled in a new command, you can also use batman.
Note that the Manpage syntax is developed in this repository and still needs some work.
prettier / shfmt / rustfmt
The prettybat script is a wrapper that will format code and print it with bat.
Warp
<a href="https://app.warp.dev/drive/folder/-Bat-Warp-Pack-lxhe7HrEwgwpG17mvrFSz1">
<img src="doc/sponsors/warp-pack-header.png" alt="Warp">
</a>
Highlighting --help messages
You can use bat to colorize help text: $ cp --help | bat -plhelp
You can also use a wrapper around this:
# in your .bashrc/.zshrc/*rc
alias bathelp='bat --plain --language=help'
help() {
"$@" --help 2>&1 | bathelp
}
Then you can do $ help cp or $ help git commit.
When you are using zsh, you can also use global aliases to override -h and --help entirely:
alias -g -- -h='-h 2>&1 | bat --language=help --style=plain'
alias -g -- --help='--help 2>&1 | bat --language=help --style=plain'
For fish, you can use abbreviations:
abbr -a --position anywhere -- --help '--help | bat -plhelp'
abbr -a --position anywhere -- -h '-h | bat -plhelp'
This way, you can keep on using cp --help, but get colorized help pages.
Be aware that in some cases, -h may not be a shorthand of --help (for example with ls). In cases where you need to use -h
as a command argument you can prepend \ to the argument (eg. ls \-h) to escape the aliasing defined above.
Please report any issues with the help syntax in this repository.
Installation
<!-- Installation instructions need to: * be for widely used systems * be non-obvious * be from somewhat official sources -->
On Ubuntu (using apt)
... and other Debian-based Linux distributions.
bat is available on Ubuntu since 20.04 ("Focal") and Debian since August 2021 (Debian 11 - "Bullseye").
If your Ubuntu/Debian installation is new enough you can simply run:
sudo apt install bat
Important: On some older Ubuntu/Debian releases, the executable is installed as batcat instead of bat (due to a name
clash with another package). On newer releases, the executable is available as bat. If bat --version does not work after installation, try batcat --version instead. You can set up a bat -> batcat symlink or alias to prevent any issues that may come up because of this and to be consistent with other distributions:
mkdir -p ~/.local/bin
ln -s /usr/bin/batcat ~/.local/bin/bat
an example alias for batcat as bat:
alias bat="batcat"
On Ubuntu (using most recent .deb packages)
... and other Debian-based Linux distributions.
If the package has not yet been promoted to your Ubuntu/Debian installation, or you want
the most recent release of bat, download the latest .deb package from the
release page and install it via:
sudo dpkg -i bat_0.18.3_amd64.deb # adapt version number and architecture
On Alpine Linux
You can install the bat package
from the official sources, provided you have the appropriate repository enabled:
apk add bat
On Arch Linux
You can install [the bat package](https://www.archlinux.org/packages/extra/x
Related Skills
apple-reminders
333.3kManage Apple Reminders via remindctl CLI (list, add, edit, complete, delete). Supports lists, date filters, and JSON/plain output.
gh-issues
333.3kFetch GitHub issues, spawn sub-agents to implement fixes and open PRs, then monitor and address PR review comments. Usage: /gh-issues [owner/repo] [--label bug] [--limit 5] [--milestone v1.0] [--assignee @me] [--fork user/repo] [--watch] [--interval 5] [--reviews-only] [--cron] [--dry-run] [--model glm-5] [--notify-channel -1002381931352]
healthcheck
333.3kHost security hardening and risk-tolerance configuration for OpenClaw deployments
himalaya
333.3kCLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
