Go to file
David Peter 22e785ca49
Update README.md
2018-04-26 00:11:10 +02:00
ci Add CI scripts 2018-04-22 15:35:24 +02:00
src Print error if Default.tmTheme is not available 2018-04-25 23:34:41 +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 Git support, closes #8 2018-04-21 17:12:25 +02:00
Cargo.toml Update help text 2018-04-22 13:45:40 +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-26 00:11:10 +02:00

README.md

bat

Build Status Version info

A cat(1) clone with wings.

Features

Syntax highlighting

bat supports a large number of programming and markup languages (see below):

Syntax highlighting example

Git integration

Additions, modifications and deletions are shown (a la git diff):

Git integration example

Installation

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

If you want to build to compile bat from source, you need Rust 1.22 or higher. You can then use cargo to build everything:

cargo install bat

Get themes and syntax highlighting definitions

bat uses the excellent syntect library for syntax highlighting. syntect uses Sublime Text language definitions and themes.

To get a big package of languages and a Monokai-variant as a theme, run:

mkdir -p ~/.config/bat/themes
cd ~/.config/bat/themes
git clone https://github.com/jonschlinkert/sublime-monokai-extended
ln -s "sublime-monokai-extended/Monokai Extended.tmTheme" Default.tmTheme

mkdir -p ~/.config/bat/syntax
cd ~/.config/bat/syntax
git clone https://github.com/sublimehq/Packages/
rm -rf Packages/Markdown
git clone https://github.com/jonschlinkert/sublime-markdown-extended