extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-11-23 00:03:27 +01:00
Code Issues Packages Projects Releases Wiki Activity
A cat(1) clone with wings.
57 Commits 10 Branches 40 Tags 47 MiB
Rust 97.2%
Python 2%
Shell 0.8%
92aa2b547e
Go to file
David Peter 92aa2b547e
Update README.md
2018-05-02 23:29:52 +02:00
assets Update syntax_set, closes #25, fixes #28 2018-05-01 09:23:04 +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 Remove openssl dependency 2018-05-02 20:45:07 +02:00
Cargo.lock Remove openssl dependency 2018-05-02 20:45:07 +02:00
Cargo.toml Bump version 2018-05-02 22:03:43 +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-05-02 23:29:52 +02:00

README.md

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

From binaries

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

Arch Linux

On Arch Linux, you can install the AUR package via yaourt, or manually:

git clone https://aur.archlinux.org/bat.git
cd bat
makepkg -si

From source

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

Customization

bat uses the excellent syntect library for syntax highlighting. syntect can read any Sublime Text .sublime-syntax file 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