2 <img src="doc/logo-header.svg" alt="bat - a cat clone with wings"><br>
3 <a href="https://github.com/sharkdp/bat/actions?query=workflow%3ACICD"><img src="https://github.com/sharkdp/bat/workflows/CICD/badge.svg" alt="Build Status"></a>
4 <img src="https://img.shields.io/crates/l/bat.svg" alt="license">
5 <a href="https://crates.io/crates/bat"><img src="https://img.shields.io/crates/v/bat.svg?colorB=319e8c" alt="Version info"></a><br>
6 A <i>cat(1)</i> clone with syntax highlighting and Git integration.
10 <a href="#syntax-highlighting">Key Features</a> •
11 <a href="#how-to-use">How To Use</a> •
12 <a href="#installation">Installation</a> •
13 <a href="#customization">Customization</a> •
14 <a href="#project-goals-and-alternatives">Project goals, alternatives</a><br>
15 [<a href="https://github.com/chinanf-boy/bat-zh">中文</a>] [<a href="doc/README-ja.md">日本語</a>] [<a href="doc/README-ko.md">한국어</a>] [<a href="doc/README-ru.md">Русский</a>]
18### Syntax highlighting
20`bat` supports syntax highlighting for a large number of programming and markup
23
27`bat` communicates with `git` to show modifications with respect to the index
30
32### Show non-printable characters
34You can use the `-A`/`--show-all` option to show and highlight non-printable
37
41By default, `bat` pipes its own output to a pager (e.g `less`) if the output is too large for one screen.
42If 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.
43If you intend to alias `cat` to `bat` in your shell configuration, you can use `alias cat='bat --paging=never'` to preserve the default behavior.
45#### File concatenation
47Even with a pager set, you can still use `bat` to concatenate files :wink:.
48Whenever `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.
52Display a single file on the terminal
58Display multiple files at once
64Read from stdin, determine the syntax automatically (note, highlighting will
65only work if the syntax can be determined from the first line of the file,
66usually through a shebang such as `#!/bin/sh`)
69> curl -s https://sh.rustup.rs | bat
72Read from stdin, specify the language explicitly
75> yaml2json .travis.yml | json_pp | bat -l json
78Show and highlight non-printable characters:
83Use it as a `cat` replacement:
86bat > note.md # quickly create a new file
88bat header.md content.md footer.md > document.md
90bat -n main.rs # show line numbers (only)
92bat f - g # output 'f', then stdin, then 'g'.
95### Integration with other tools
99You can use the `-exec` option of `find` to preview all search results with `bat`:
104If you happen to use [`fd`](https://github.com/sharkdp/fd), you can use the `-X`/`--exec-batch` option to do the same:
111With [`batgrep`](https://github.com/eth-p/bat-extras/blob/master/doc/batgrep.md), `bat` can be used as the printer for [`ripgrep`](https://github.com/BurntSushi/ripgrep) search results.
119`bat` can be combined with `tail -f` to continuously monitor a given file with syntax highlighting.
121tail -f /var/log/pacman.log | bat --paging=never -l log
123Note that we have to switch off paging in order for this to work. We have also specified the syntax
124explicitly (`-l log`), as it can not be auto-detected in this case.
128You can combine `bat` with `git show` to view an older version of a given file with proper syntax
131git show v0.6.0:src/main.rs | bat -l rs
136You can combine `bat` with `git diff` to view lines around code changes with proper syntax
140 git diff --name-only --diff-filter=d | xargs bat --diff
143If you prefer to use this as a separate tool, check out `batdiff` in [`bat-extras`](https://github.com/eth-p/bat-extras).
145If you are looking for more support for git and diff operations, check out [`delta`](https://github.com/dandavison/delta).
149The line numbers and Git modification markers in the output of `bat` can make it hard to copy
150the contents of a file. To prevent this, you can call `bat` with the `-p`/`--plain` option or
151simply pipe the output into `xclip`:
155`bat` will detect that the output is being redirected and print the plain file contents.
159`bat` can be used as a colorizing pager for `man`, by setting the
160`MANPAGER` environment variable:
163export MANPAGER="sh -c 'col -bx | bat -l man -p'"
167It might also be necessary to set `MANROFFOPT="-c"` if you experience
170If you prefer to have this bundled in a new command, you can also use [`batman`](https://github.com/eth-p/bat-extras/blob/master/doc/batman.md).
172Note that the [Manpage syntax](assets/syntaxes/02_Extra/Manpage.sublime-syntax) is developed in this repository and still needs some work.
174Also, note that this will [not work](https://github.com/sharkdp/bat/issues/1145) with Mandocs `man` implementation.
176#### `prettier` / `shfmt` / `rustfmt`
178The [`prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) script is a wrapper that will format code and print it with `bat`.
183[](https://repology.org/project/bat/versions)
185### On Ubuntu (using `apt`)
186*... and other Debian-based Linux distributions.*
188`bat` is making its way through the [Ubuntu](https://packages.ubuntu.com/eoan/bat) and
189[Debian](https://packages.debian.org/sid/bat) package release process, and is available
190for Ubuntu as of Eoan 19.10. On Debian `bat` is currently only available on the unstable
193If your Ubuntu/Debian installation is new enough you can simply run:
199**Important**: If you install `bat` this way, please note that the executable may be installed as `batcat` instead of `bat` (due to [a name
200clash with another package](https://github.com/sharkdp/bat/issues/982)). 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:
203ln -s /usr/bin/batcat ~/.local/bin/bat
206### On Ubuntu (using most recent `.deb` packages)
207*... and other Debian-based Linux distributions.*
209If the package has not yet been promoted to your Ubuntu/Debian installation, or you want
210the most recent release of `bat`, download the latest `.deb` package from the
211[release page](https://github.com/sharkdp/bat/releases) and install it via:
214sudo dpkg -i bat_0.17.1_amd64.deb # adapt version number and architecture
219You can install [the `bat` package](https://pkgs.alpinelinux.org/packages?name=bat)
220from the official sources, provided you have the appropriate repository enabled:
228You can install [the `bat` package](https://www.archlinux.org/packages/community/x86_64/bat/)
229from the official sources:
237You can install [the `bat` package](https://koji.fedoraproject.org/koji/packageinfo?packageID=27506) from the official [Fedora Modular](https://docs.fedoraproject.org/en-US/modularity/using-modules/) repository.
245You can install [the `bat` package](https://packages.gentoo.org/packages/sys-apps/bat)
246from the official sources:
254You can install `bat` via xbps-install:
261You can install `bat` via pkg:
268You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
274or build it on your own from the FreeBSD ports:
277cd /usr/ports/textproc/bat
283You can install `bat` using the [nix package manager](https://nixos.org/nix):
291You can install `bat` with zypper:
300sudo snap install batcat
303[Get it from the Snap Store](https://snapcraft.io/batcat)
306### On macOS (or Linux) via Homebrew
308You can install `bat` with [Homebrew on MacOS](https://formulae.brew.sh/formula/bat) or [Homebrew on Linux](https://formulae.brew.sh/formula-linux/bat):
314### On macOS via MacPorts
316Or install `bat` with [MacPorts](https://ports.macports.org/port/bat/summary):
324There are a few options to install `bat` on Windows. Once you have installed `bat`,
325take a look at the ["Using `bat` on Windows"](#using-bat-on-windows) section.
329You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
333You can install `bat` via [Chocolatey](https://chocolatey.org/packages/Bat):
340You can install `bat` via [scoop](https://scoop.sh/):
345#### From prebuilt binaries:
347You can download prebuilt binaries from the [Release page](https://github.com/sharkdp/bat/releases),
349You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
353Check out the [Release page](https://github.com/sharkdp/bat/releases) for
354prebuilt versions of `bat` for many different architectures. Statically-linked
355binaries are also available: look for archives with `musl` in the file name.
359If you want to build `bat` from source, you need Rust 1.40 or
360higher. You can then use `cargo` to build everything:
363cargo install --locked bat
366Note that additional files like the man page or shell completion
367files can not be installed in this way. They will be generated by `cargo` and should be available in the cargo target folder (under `build`).
371### Highlighting theme
373Use `bat --list-themes` to get a list of all available themes for syntax
374highlighting. To select the `TwoDark` theme, call `bat` with the
375`--theme=TwoDark` option or set the `BAT_THEME` environment variable to
376`TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to
377make the change permanent. Alternatively, use `bat`s
378[configuration file](https://github.com/sharkdp/bat#configuration-file).
380If you want to preview the different themes on a custom file, you can use
381the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this):
383bat --list-themes | fzf --preview="bat --theme={} --color=always /path/to/file"
386`bat` looks good on a dark background by default. However, if your terminal uses a
387light background, some themes like `GitHub` or `OneHalfLight` will work better for you.
388You can also use a custom theme by following the
389['Adding new themes' section below](https://github.com/sharkdp/bat#adding-new-themes).
393`bat` has three themes that always use [8-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors),
394even when truecolor support is available:
396- `ansi` looks decent on any terminal. It uses 3-bit colors: black, red, green,
397 yellow, blue, magenta, cyan, and white.
398- `base16` is designed for [base16](https://github.com/chriskempson/base16) terminal themes. It uses
399 4-bit colors (3-bit colors plus bright variants) in accordance with the
400 [base16 styling guidelines](https://github.com/chriskempson/base16/blob/master/styling.md).
401- `base16-256` is designed for [base16-shell](https://github.com/chriskempson/base16-shell).
402 It replaces certain bright colors with 8-bit colors from 16 to 21. **Do not** use this simply
403 because you have a 256-color terminal but are not using base16-shell.
405Although these themes are more restricted, they have two advantages over truecolor themes:
407- They harmonize better with other terminal software using 3-bit or 4-bit colors.
408- When you change your terminal theme, `bat` output already on the screen will update to match.
412You can use the `--style` option to control the appearance of `bat`s output.
413You can use `--style=numbers,changes`, for example, to show only Git changes
414and line numbers but no grid and no file header. Set the `BAT_STYLE` environment
415variable to make these changes permanent or use `bat`s
416[configuration file](https://github.com/sharkdp/bat#configuration-file).
418### Adding new syntaxes / language definitions
420Should you find that a particular syntax is not available within `bat`, you can follow these
421instructions to easily add new syntaxes to your current `bat` installation.
423`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/)
424library for syntax highlighting. `syntect` can read any
425[Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html)
428A good resource for finding Sublime Syntax packages is [Package Control](https://packagecontrol.io/). Once you found a
4311. Create a folder with syntax definition files:
434 mkdir -p "$(bat --config-dir)/syntaxes"
435 cd "$(bat --config-dir)/syntaxes"
437 # Put new '.sublime-syntax' language definition files
438 # in this folder (or its subdirectories), for example:
439 git clone https://github.com/tellnobody1/sublime-purescript-syntax
4422. Now use the following command to parse these files into a binary cache:
4483. Finally, use `bat --list-languages` to check if the new languages are available.
450 If you ever want to go back to the default settings, call:
4564. If you think that a specific syntax should be included in `bat` by default, please
457 consider opening a "syntax request" ticket after reading the policies and
458 instructions [here](doc/assets.md): [Open Syntax Request](https://github.com/sharkdp/bat/issues/new?labels=syntax-request&template=syntax_request.md).
462This works very similar to how we add new syntax definitions.
464First, create a folder with the new syntax highlighting themes:
466mkdir -p "$(bat --config-dir)/themes"
467cd "$(bat --config-dir)/themes"
469# Download a theme in '.tmTheme' format, for example:
470git clone https://github.com/greggb/sublime-snazzy
472# Update the binary cache
476Finally, use `bat --list-themes` to check if the new themes are available.
478### Adding or changing file type associations
480You can add new (or change existing) file name patterns using the `--map-syntax`
481command line option. The option takes an argument of the form `pattern:syntax` where
482`pattern` is a glob pattern that is matched against the file name and
483the absolute file path. The `syntax` part is the full name of a supported language
484(use `bat --list-languages` for an overview)full .
486Note: You probably want to use this option as an entry in `bat`s configuration file instead
487of passing it on the command line (see below).
489Example: To use "INI" syntax highlighting for all files with a `.conf` file extension, use
491--map-syntax='*.conf:INI'
494Example: To open all files called `.ignore` (exact match) with the "Git Ignore" syntax, use:
496--map-syntax='.ignore:Git Ignore'
499Example: To open all `.conf` files in subfolders of `/etc/apache2` with the "Apache Conf"
500syntax, use (this mapping is already built in):
502-map-syntax='/etc/apache2/**/*.conf:Apache Conf'
505### Using a different pager
507`bat` uses the pager that is specified in the `PAGER` environment variable. If this variable is not
508set, `less` is used by default. If you want to use a different pager, you can either modify the
509`PAGER` variable or set the `BAT_PAGER` environment variable to override what is specified in
512If you want to pass command-line arguments to the pager, you can also set them via the
513`PAGER`/`BAT_PAGER` variables:
516export BAT_PAGER="less -RF"
519Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option).
521**Note**: By default, if the pager is set to `less` (and no command-line options are specified),
522`bat` will pass the following command line options to the pager: `-R`/`--RAW-CONTROL-CHARS`,
523`-F`/`--quit-if-one-screen` and `-X`/`--no-init`. The last option (`-X`) is only used for `less`
524versions older than 530.
526The `-R` option is needed to interpret ANSI colors correctly. The second option (`-F`) instructs
527less to exit immediately if the output size is smaller than the vertical size of the terminal.
528This is convenient for small files because you do not have to press `q` to quit the pager. The
529third option (`-X`) is needed to fix a bug with the `--quit-if-one-screen` feature in old versions
530of `less`. Unfortunately, it also breaks mouse-wheel support in `less`.
532If you want to enable mouse-wheel scrolling on older versions of `less`, you can pass just `-R` (as
533in the example above, this will disable the quit-if-one-screen feature). For less 530 or newer,
534it should work out of the box.
538`bat` expands tabs to 4 spaces by itself, not relying on the pager. To change this, simply add the
539`--tabs` argument with the number of spaces you want to be displayed.
541**Note**: Defining tab stops for the pager (via the `--pager` argument by `bat`, or via the `LESS`
542environment variable for `less`) won't be taken into account because the pager will already get
543expanded spaces instead of tabs. This behaviour is added to avoid indentation issues caused by the
544sidebar. Calling `bat` with `--tabs=0` will override it and let tabs be consumed by the pager.
548If you make use of the dark mode feature in macOS, you might want to configure `bat` to use a different
549theme based on the OS theme. The following snippet uses the `default` theme when in the _dark mode_
550and the `GitHub` theme when in the _light mode_.
553alias cat="bat --theme=\$(defaults read -globalDomain AppleInterfaceStyle &> /dev/null && echo default || echo GitHub)"
559`bat` can also be customized with a configuration file. The location of the file is dependent
560on your operating system. To get the default path for your system, call
565Alternatively, you can use the `BAT_CONFIG_PATH` environment variable to point `bat` to a
566non-default location of the configuration file:
568export BAT_CONFIG_PATH="/path/to/bat.conf"
571A default configuration file can be created with the `--generate-config-file` option.
573bat --generate-config-file
578The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.
580Example configuration file:
582# Set the theme to "TwoDark"
585# Show line numbers, Git modifications and file header (but no grid)
586--style="numbers,changes,header"
588# Use italic text on the terminal (not supported on all terminals)
591# Use C++ syntax for .ino files
592--map-syntax "*.ino:C++"
595## Using `bat` on Windows
597`bat` mostly works out-of-the-box on Windows, but a few features may need extra configuration.
601You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
605Windows only includes a very limited pager in the form of `more`. You can download a Windows binary
606for `less` [from its homepage](http://www.greenwoodsoftware.com/less/download.html) or [through
607Chocolatey](https://chocolatey.org/packages/Less). To use it, place the binary in a directory in
608your `PATH` or [define an environment variable](#using-a-different-pager). The [Chocolatey package](#on-windows) installs `less` automatically.
612Windows 10 natively supports colors in both `conhost.exe` (Command Prompt) and PowerShell since
613[v1511](https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1511_(November_Update)), as
614well as in newer versions of bash. On earlier versions of Windows, you can use
615[Cmder](http://cmder.net/), which includes [ConEmu](https://conemu.github.io/).
617**Note:** The Git and MSYS versions of `less` do not correctly interpret colors on Windows. If you
618don’t have any other pagers installed, you can disable paging entirely by passing `--paging=never`
619or by setting `BAT_PAGER` to an empty string.
623`bat` on Windows does not natively support Cygwin's unix-style paths (`/cygdrive/*`). When passed an absolute cygwin path as an argument, `bat` will encounter the following error: `The system cannot find the path specified. (os error 3)`
625This can be solved by creating a wrapper or adding the following function to your `.bash_profile` file:
631 for index in $(seq 0 ${#args[@]}) ; do
632 case "${args[index]}" in
634 *) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[index]}")";;
637 command bat "${args[@]}"
643### Terminals & colors
645`bat` handles terminals *with* and *without* truecolor support. However, the colors in most syntax
646highlighting themes are not optimized for 8-bit colors. It is therefore strongly recommended
647that you use a terminal with 24-bit truecolor support (`terminator`, `konsole`, `iTerm2`, ...),
648or use one of the basic [8-bit themes](#8-bit-themes) designed for a restricted set of colors.
649See [this article](https://gist.github.com/XVilka/8346728) for more details and a full list of
650terminals with truecolor support.
652Make sure that your truecolor terminal sets the `COLORTERM` variable to either `truecolor` or
653`24bit`. Otherwise, `bat` will not be able to determine whether or not 24-bit escape sequences
654are supported (and fall back to 8-bit colors).
656### Line numbers and grid are hardly visible
658Please try a different theme (see `bat --list-themes` for a list). The `OneHalfDark` and
659`OneHalfLight` themes provide grid and line colors that are brighter.
663`bat` natively supports UTF-8 as well as UTF-16. For every other file encoding, you may need to
664convert to UTF-8 first because the encodings can typically not be auto-detected. You can `iconv`
666Example: if you have a PHP file in Latin-1 (ISO-8859-1) encoding, you can call:
668iconv -f ISO-8859-1 -t UTF-8 my-file.php | bat
670Note: you might have to use the `-l`/`--language` option if the syntax can not be auto-detected
676# Recursive clone to retrieve all submodules
677git clone --recursive https://github.com/sharkdp/bat
679# Build (debug version)
683# Run unit tests and integration tests
686# Install (release version)
687cargo install --path . --locked
689# Build a bat binary with modified syntaxes and themes
691cargo install --path . --locked --force
696Take a look at the [`CONTRIBUTING.md`](CONTRIBUTING.md) guide.
700- [sharkdp](https://github.com/sharkdp)
701- [eth-p](https://github.com/eth-p)
702- [keith-hall](https://github.com/keith-hall)
704## Project goals and alternatives
706`bat` tries to achieve the following goals:
708- Provide beautiful, advanced syntax highlighting
709- Integrate with Git to show file modifications
710- Be a drop-in replacement for (POSIX) `cat`
711- Offer a user-friendly command-line interface
713There are a lot of alternatives, if you are looking for similar programs. See
714[this document](doc/alternatives.md) for a comparison.
717Copyright (c) 2018-2020 [bat-developers](https://github.com/sharkdp/bat).
719`bat` is made available under the terms of either the MIT License or the Apache License 2.0, at your option.
721See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files for license details.
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list