2018-04-21 15:23:57 +03:00
# bat
2018-04-22 17:08:49 +03:00
[![Build Status ](https://travis-ci.org/sharkdp/bat.svg?branch=master )](https://travis-ci.org/sharkdp/bat)
[![Version info ](https://img.shields.io/crates/v/bat.svg )](https://crates.io/crates/bat)
2018-04-30 17:05:36 +03:00
A *cat(1)* clone with syntax highlighting and Git integration.
2018-04-21 15:23:57 +03:00
2018-04-22 16:30:28 +03:00
## Features
### Syntax highlighting
2018-04-30 16:54:03 +03:00
`bat` supports syntax highlighting for a large number of programming and markup languages:
2018-04-22 16:30:28 +03:00
2018-04-26 01:02:53 +03:00
![Syntax highlighting example ](https://imgur.com/rGsdnDe.png )
2018-04-22 16:30:28 +03:00
### Git integration
2018-04-26 01:12:49 +03:00
`bat` communicates with `git` to show modifications with respect to the index (see left side bar):
2018-04-26 01:02:53 +03:00
2018-04-26 01:03:25 +03:00
![Git integration example ](https://i.imgur.com/2lSW4RE.png )
2018-04-22 17:15:07 +03:00
## Installation
2018-05-02 21:01:43 +03:00
### From binaries
2018-04-26 01:02:53 +03:00
Check out the [Release page ](https://github.com/sharkdp/bat/releases ) for binary builds and Debian packages.
2018-05-01 01:04:40 +03:00
### Arch Linux
On Arch Linux, you can install [the AUR package ](https://aur.archlinux.org/packages/bat/ ) via yaourt, or manually:
```bash
git clone https://aur.archlinux.org/bat.git
cd bat
makepkg -si
```
2018-04-30 16:40:51 +03:00
### From source
2018-05-03 09:22:31 +03:00
If you want to build to compile `bat` from source, you need Rust 1.24 or higher.
2018-05-02 21:01:43 +03:00
You can then use `cargo` to build everything:
2018-04-25 21:49:49 +03:00
2018-04-24 01:44:39 +03:00
``` bash
2018-04-22 17:15:07 +03:00
cargo install bat
2018-04-26 01:02:53 +03:00
```
2018-04-30 17:03:33 +03:00
## Customization
2018-05-03 00:29:52 +03:00
`bat` uses the excellent [`syntect` ](https://github.com/trishume/syntect/ ) library for syntax highlighting. `syntect` can read any [Sublime Text `.sublime-syntax` file ](https://www.sublimetext.com/docs/3/syntax.html ) and theme.
2018-04-30 17:03:33 +03:00
2018-04-30 17:05:36 +03:00
To build your own language-set and theme, follow these steps:
2018-04-30 17:03:33 +03:00
2018-04-30 17:05:36 +03:00
Create a folder with a syntax highlighting theme:
2018-05-02 23:21:56 +03:00
2018-04-30 17:03:33 +03:00
``` bash
mkdir -p ~/.config/bat/themes
cd ~/.config/bat/themes
# Download a theme, for example:
git clone https://github.com/jonschlinkert/sublime-monokai-extended
# Create a 'Default.tmTheme' link
ln -s "sublime-monokai-extended/Monokai Extended.tmTheme" Default.tmTheme
```
Create a folder with language definition files:
2018-05-02 23:21:56 +03:00
2018-04-30 17:03:33 +03:00
``` bash
mkdir -p ~/.config/bat/syntax
cd ~/.config/bat/syntax
# Download some language definition files, for example:
git clone https://github.com/sublimehq/Packages/
rm -rf Packages/Markdown
git clone https://github.com/jonschlinkert/sublime-markdown-extended
```
Finally, use the following command to parse all these files into a binary
cache:
2018-05-02 23:21:56 +03:00
2018-04-30 17:03:33 +03:00
``` bash
bat init-cache
```