bat/README.md

160 lines
3.4 KiB
Markdown
Raw Normal View History

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 16:05:36 +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-05-07 20:06:01 +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-05-07 20:06:01 +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
### Automatic paging
`bat` can pipe its own output to `less` if the output is too large for one screen.
### File concatenation
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.
2018-05-09 00:33:49 +02:00
## Usage
Display a single file on the terminal
``` bash
> bat README.md
```
Display multiple files at once
``` bash
> bat src/*.rs
```
Explicitly specify the language
``` bash
> yaml2json .travis.yml | json_pp | bat -l json
```
``` bash
> curl -s https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs | bat -l rs
```
2018-04-22 16:15:07 +02:00
## Installation
2018-05-02 20:01:43 +02:00
### From binaries
2018-05-07 20:06:01 +02:00
Check out the [Release page](https://github.com/sharkdp/bat/releases) for
binary builds and Debian packages.
2018-04-26 00:02:53 +02:00
#### 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
```
#### On FreeBSD
You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
```sh
pkg install bat
```
or build it on your own from the FreeBSD ports:
```sh
cd /usr/ports/textproc/bat
make install
```
#### On macOS
You can install `bat` with [Homebrew](http://braumeister.org/formula/bat):
``` bash
brew install bat
```
### From source
2018-05-07 20:06:01 +02:00
If you want to build to compile `bat` from source, you need Rust 1.24 or
higher. You can then use `cargo` to build everything:
``` bash
2018-04-22 16:15:07 +02:00
cargo install bat
2018-04-26 00:02:53 +02:00
```
2018-04-30 16:03:33 +02:00
On macOS, you might have to install `cmake` (`brew install cmake`) in order for
some dependencies to be built.
2018-04-30 16:03:33 +02:00
## Customization
2018-05-07 20:06:01 +02: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 16:03:33 +02:00
2018-04-30 16:05:36 +02:00
To build your own language-set and theme, follow these steps:
2018-04-30 16:03:33 +02:00
2018-04-30 16:05:36 +02:00
Create a folder with a syntax highlighting theme:
2018-05-02 22:21:56 +02:00
2018-04-30 16:03:33 +02:00
``` bash
BAT_CONFIG_DIR="$(bat cache --config-dir)"
mkdir -p "$BAT_CONFIG_DIR/themes"
cd "$BAT_CONFIG_DIR/themes"
2018-04-30 16:03:33 +02:00
# 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 22:21:56 +02:00
2018-04-30 16:03:33 +02:00
``` bash
mkdir -p "$BAT_CONFIG_DIR/syntaxes"
cd "$BAT_CONFIG_DIR/syntaxes"
2018-04-30 16:03:33 +02:00
# 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 22:21:56 +02:00
2018-04-30 16:03:33 +02:00
``` bash
bat cache --init
```
If you ever want to go back to the default settings, call:
``` bash
bat cache --clear
2018-04-30 16:03:33 +02:00
```