2018-04-21 14:23:57 +02:00
|
|
|
# bat
|
2018-04-22 16:08:49 +02: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 13:10:50 +02:00
|
|
|
*A cat(1) clone with syntax highlighting and Git integration.*
|
2018-04-21 14:23:57 +02:00
|
|
|
|
2018-04-22 15:30:28 +02:00
|
|
|
## Features
|
|
|
|
|
|
|
|
### Syntax highlighting
|
|
|
|
|
2018-04-30 15:54:03 +02:00
|
|
|
`bat` supports syntax highlighting for a large number of programming and markup languages:
|
2018-04-22 15:30:28 +02:00
|
|
|
|
2018-04-26 00:02:53 +02:00
|
|
|
![Syntax highlighting example](https://imgur.com/rGsdnDe.png)
|
2018-04-22 15:30:28 +02:00
|
|
|
|
|
|
|
### Git integration
|
|
|
|
|
2018-04-26 00:12:49 +02:00
|
|
|
`bat` communicates with `git` to show modifications with respect to the index (see left side bar):
|
2018-04-26 00:02:53 +02:00
|
|
|
|
2018-04-26 00:03:25 +02:00
|
|
|
![Git integration example](https://i.imgur.com/2lSW4RE.png)
|
2018-04-22 16:15:07 +02:00
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
2018-04-26 00:02:53 +02:00
|
|
|
Check out the [Release page](https://github.com/sharkdp/bat/releases) for binary builds and Debian packages.
|
|
|
|
|
2018-04-30 15:40:51 +02:00
|
|
|
### From source
|
|
|
|
|
2018-04-26 00:02:53 +02:00
|
|
|
If you want to build to compile `bat` from source, you need Rust 1.22 or higher.
|
2018-04-30 15:40:51 +02:00
|
|
|
Make sure that you have the devel-version of libopenssl installed (see instructions
|
|
|
|
[here](https://github.com/sfackler/rust-openssl)). You can then use `cargo` to build everything:
|
2018-04-25 20:49:49 +02:00
|
|
|
|
2018-04-24 00:44:39 +02:00
|
|
|
``` bash
|
2018-04-22 16:15:07 +02:00
|
|
|
cargo install bat
|
2018-04-26 00:02:53 +02:00
|
|
|
```
|