A cat(1) clone with wings.
Go to file
2018-04-30 16:05:36 +02:00
assets Add binary assets 2018-04-30 15:41:30 +02:00
ci Add CI scripts 2018-04-22 15:35:24 +02:00
src Add customization chapter 2018-04-30 16:03:39 +02:00
.gitignore Initial commit 2018-04-21 12:53:24 +02:00
.travis.yml Bump to rust 1.22.1 2018-04-26 00:06:50 +02:00
Cargo.lock Add customization chapter 2018-04-30 16:03:39 +02:00
Cargo.toml Add customization chapter 2018-04-30 16:03:39 +02:00
LICENSE-APACHE Add license 2018-04-22 15:34:14 +02:00
LICENSE-MIT Add license 2018-04-22 15:34:14 +02:00
README.md Update README.md 2018-04-30 16:05:36 +02:00

bat

Build Status Version info

A cat(1) clone with syntax highlighting and Git integration.

Features

Syntax highlighting

bat supports syntax highlighting for a large number of programming and markup languages:

Syntax highlighting example

Git integration

bat communicates with git to show modifications with respect to the index (see left side bar):

Git integration example

Installation

Check out the Release page for binary builds and Debian packages.

From source

If you want to build to compile bat from source, you need Rust 1.22 or higher. Make sure that you have the devel-version of libopenssl installed (see instructions here). You can then use cargo to build everything:

cargo install bat

Customization

bat uses the excellent syntect library for syntax highlighting. syntect can read any Sublime Text language definition and theme.

To build your own language-set and theme, follow these steps:

Create a folder with a syntax highlighting theme:

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:

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:

bat init-cache