bat/README.md

472 lines
14 KiB
Markdown
Raw Normal View History

2018-05-22 21:54:34 +02:00
<p align="center">
<img src="doc/logo-header.svg" alt="bat - a cat clone with wings"><br>
2018-07-17 23:37:03 +02:00
<a href="https://travis-ci.org/sharkdp/bat"><img src="https://travis-ci.org/sharkdp/bat.svg?branch=master" alt="Build Status"></a>
2018-08-29 18:51:47 +02:00
<a href="https://ci.appveyor.com/project/sharkdp/bat"><img src="https://ci.appveyor.com/api/projects/status/cptsmtbiwbnr2vhf?svg=true"></a>
2018-05-30 21:02:40 +02:00
<img src="https://img.shields.io/crates/l/bat.svg" alt="license">
2018-05-30 21:10:14 +02:00
<a href="https://crates.io/crates/bat"><img src="https://img.shields.io/crates/v/bat.svg?colorB=319e8c" alt="Version info"></a><br>
2018-05-22 21:54:34 +02:00
A <i>cat(1)</i> clone with syntax highlighting and Git integration.
</p>
2018-04-21 14:23:57 +02:00
2018-05-30 21:23:24 +02:00
<p align="center">
<a href="#syntax-highlighting">Key Features</a>
<a href="#how-to-use">How To Use</a>
<a href="#installation">Installation</a>
<a href="#customization">Customization</a>
2018-10-19 21:23:13 +02:00
<a href="#project-goals-and-alternatives">Project goals, alternatives</a>
Translation [<a href="https://github.com/chinanf-boy/bat-zh">中文</a>]
2018-05-30 21:23:24 +02:00
</p>
2018-04-22 15:30:28 +02:00
### 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
2018-11-11 13:19:34 +01:00
### Show non-printable characters
2018-11-11 14:28:18 +01:00
You can use the `-A`/`--show-all` option to show and highlight non-printable
characters:
2018-11-11 14:32:59 +01:00
![Non-printable character example](https://i.imgur.com/WndGp9H.png)
2018-11-11 13:19:34 +01: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
2018-11-11 14:35:08 +01:00
`bat` detects a non-interactive terminal (i.e. when you pipe into another process
or into a file), `bat` will act as a drop-in replacement for `cat` and
fall back to printing the plain file contents.
2018-05-30 21:23:24 +02:00
## How to use
2018-05-09 00:33:49 +02:00
Display a single file on the terminal
```bash
2018-05-09 00:33:49 +02:00
> bat README.md
```
Display multiple files at once
```bash
2018-05-09 00:33:49 +02:00
> bat src/*.rs
```
2018-10-07 18:39:52 +02:00
Read from stdin, determine the syntax automatically
2018-05-09 00:33:49 +02:00
```bash
2018-10-07 18:39:52 +02:00
> curl -s https://sh.rustup.rs | bat
2018-05-09 00:33:49 +02:00
```
2018-10-07 18:39:52 +02:00
Read from stdin, specify the language explicitly
```bash
2018-10-07 18:39:52 +02:00
> yaml2json .travis.yml | json_pp | bat -l json
2018-05-09 00:33:49 +02:00
```
2018-11-11 14:28:18 +01:00
Show and highlight non-printable characters:
```bash
> bat -A /etc/hosts
```
2018-10-07 18:39:52 +02:00
2018-11-11 14:28:18 +01:00
Use it as a `cat` replacement:
2018-05-31 22:57:18 +02:00
```bash
bat > note.md # quickly create a new file
bat header.md content.md footer.md > document.md
bat -n main.rs # show line numbers (only)
2018-06-01 16:32:33 +02:00
bat f - g # output 'f', then stdin, then 'g'.
2018-05-31 22:57:18 +02:00
```
2018-05-09 00:33:49 +02:00
2018-04-22 16:15:07 +02:00
## Installation
2018-08-28 20:55:15 +02:00
### On Ubuntu
*... and other Debian-based Linux distributions.*
2018-05-02 20:01:43 +02:00
2018-08-28 20:55:15 +02:00
Download the latest `.deb` package from the [release page](https://github.com/sharkdp/bat/releases)
and install it via:
``` bash
2018-11-11 12:55:38 +01:00
sudo dpkg -i bat_0.9.0_amd64.deb # adapt version number and architecture
2018-08-28 20:55:15 +02:00
```
2018-04-26 00:02:53 +02:00
2018-08-28 21:04:41 +02:00
### On Arch Linux
2018-08-28 20:55:15 +02:00
You can install [the `bat` package](https://www.archlinux.org/packages/community/x86_64/bat/)
from the official sources:
```bash
2018-06-08 11:34:57 +02:00
pacman -S bat
```
2018-08-28 20:55:15 +02:00
### On Void Linux
You can install `bat` via xbps-install:
```
xbps-install -S bat
```
2018-08-28 21:04:41 +02:00
### On FreeBSD
You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
```bash
pkg install bat
```
or build it on your own from the FreeBSD ports:
```bash
cd /usr/ports/textproc/bat
make install
```
2018-10-11 20:05:17 +02:00
### Via nix
You can install `bat` using the [nix package manager](https://nixos.org/nix):
```bash
nix-env -i bat
```
2018-11-06 15:53:39 +01:00
### On openSUSE
You can install `bat` with zypper:
```
zypper install bat
```
2018-10-11 20:05:17 +02:00
### On macOS
You can install `bat` with [Homebrew](http://braumeister.org/formula/bat):
```bash
brew install bat
```
### On Windows
You can download prebuilt binaries from the [Release page](https://github.com/sharkdp/bat/releases),
or install it with [scoop](https://scoop.sh/):
```bash
scoop install bat
```
[See below](#using-bat-on-windows) for notes.
### Via Docker
There is a [Docker image](https://hub.docker.com/r/danlynn/bat/) that you can use to run `bat` in a container:
```bash
docker pull danlynn/bat
2018-10-11 20:57:46 +02:00
alias bat='docker run -it --rm -e BAT_THEME -e BAT_STYLE -e BAT_TABS -v "$(pwd):/myapp" danlynn/bat'
2018-10-11 20:05:17 +02:00
```
### Via Ansible
You can install `bat` with [Ansible](https://www.ansible.com/):
```bash
# Install role on local machine
ansible-galaxy install aeimer.install_bat
```
```yaml
---
# Playbook to install bat
- host: all
roles:
- aeimer.install_bat
```
- [Ansible Galaxy](https://galaxy.ansible.com/aeimer/install_bat)
2018-09-20 14:50:54 +02:00
- [GitHub](https://github.com/aeimer/ansible-install-bat)
This should work with the following distributions:
- Debian/Ubuntu
- ARM (eg. Raspberry PI)
- Arch Linux
- Void Linux
- FreeBSD
- MacOS
2018-08-28 20:55:15 +02:00
### From binaries
Check out the [Release page](https://github.com/sharkdp/bat/releases) for
2018-10-05 23:01:46 +02:00
prebuilt versions of `bat` for many different architectures. Statically-linked
2018-11-11 14:28:18 +01:00
binaries are also available: look for archives with `musl` in the file name.
2018-08-28 20:55:15 +02:00
### From source
2018-10-11 23:03:40 +02:00
If you want to build `bat` from source, you need Rust 1.29 or
2018-05-07 20:06:01 +02:00
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
You may have to install `cmake` and the `libz` development package
(`libz-dev` or `libz-devel`) in order for the build to succeed.
2018-04-30 16:03:33 +02:00
## Customization
2018-05-30 21:32:40 +02:00
### Highlighting theme
Use `bat --list-themes` to get a list of all available themes for syntax
2018-07-23 21:58:06 +02:00
highlighting. To select the `TwoDark` theme, call `bat` with the
`--theme=TwoDark` option or set the `BAT_THEME` environment variable to
2018-09-20 14:50:54 +02:00
`TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to
2018-11-11 14:28:18 +01:00
make the change permanent. Alternatively, use `bat`s
[configuration file](https://github.com/sharkdp/bat#configuration-file).
If you want to preview the different themes on a custom file, you can use
the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this):
``` bash
bat --list-themes | fzf --preview="bat --theme={} --color=always /path/to/file"
```
2018-05-30 21:32:40 +02:00
`bat` looks good on a dark background by default. However, if your terminal uses a
2018-11-11 14:28:18 +01:00
light background, some themes like `GitHub` or `OneHalfLight` will work better for you.
You can also use a custom theme by following the
['Adding new themes' section below](https://github.com/sharkdp/bat#adding-new-themes).
2018-05-30 21:32:40 +02:00
### Output style
You can use the `--style` option to control the appearance of `bat`s output.
You can use `--style=numbers,changes`, for example, to show only Git changes
2018-11-11 14:28:18 +01:00
and line numbers but no grid and no file header. Set the `BAT_STYLE` environment
variable to make these changes permanent or use `bat`s
[configuration file](https://github.com/sharkdp/bat#configuration-file).
2018-05-30 21:32:40 +02:00
### Adding new syntaxes / language definitions
2018-05-30 21:32:40 +02:00
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. To add new syntax definitions, do the following.
2018-04-30 16:03:33 +02:00
Create a folder with syntax definition files:
2018-05-02 22:21:56 +02:00
```bash
BAT_CONFIG_DIR="$(bat cache --config-dir)"
mkdir -p "$BAT_CONFIG_DIR/syntaxes"
cd "$BAT_CONFIG_DIR/syntaxes"
2018-04-30 16:03:33 +02:00
# Put new '.sublime-syntax' language definition files
# in this folder (or its subdirectories), for example:
git clone https://github.com/tellnobody1/sublime-purescript-syntax
2018-04-30 16:03:33 +02:00
```
Now use the following command to parse these files into a binary cache:
2018-05-02 22:21:56 +02:00
```bash
bat cache --init
```
Finally, use `bat --list-languages` to check if the new languages are available.
If you ever want to go back to the default settings, call:
```bash
bat cache --clear
2018-04-30 16:03:33 +02:00
```
### Adding new themes
This works very similar to how we add new syntax definitions.
First, create a folder with the new syntax highlighting themes:
```bash
BAT_CONFIG_DIR="$(bat cache --config-dir)"
mkdir -p "$BAT_CONFIG_DIR/themes"
cd "$BAT_CONFIG_DIR/themes"
# Download a theme in '.tmTheme' format, for example:
git clone https://github.com/greggb/sublime-snazzy
# Update the binary cache
bat cache --init
```
Finally, use `bat --list-themes` to check if the new themes are available.
### Using a different pager
`bat` uses the pager that is specified in the `PAGER` environment variable. If this variable is not
set, `less` is used by default. If you want to use a different pager, you can either modify the
`PAGER` variable or set the `BAT_PAGER` environment variable to override what is specified in
2018-09-26 18:08:24 +02:00
`PAGER`.
If you want to pass command-line arguments to the pager, you can also set them via the
`PAGER`/`BAT_PAGER` variables:
```bash
export BAT_PAGER="less -RF"
```
2018-11-11 14:28:18 +01:00
Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option).
2018-10-20 14:56:25 +02:00
**Note**: By default, if the pager is set to `less` (any no command-line options are specified),
`bat` will pass the following command line
options to the pager: `-R`/`--RAW-CONTROL-CHARS`, `-F`/`--quit-if-one-screen` and `-X`/`--no-init`.
The first (`-R`) is needed to interpret ANSI colors correctly. The second option (`-F`) instructs
less to exit immediately if the output size is smaller than the vertical size of the terminal.
This is convenient for small files because you do not have to press `q` to quit the pager. The
third option (`-X`) is needed to fix a bug with the `--quit-if-one-screen` feature in old versions
of `less`. Unfortunately, it also breaks mouse-wheel support in `less`. If you want to enable
mouse-wheel scrolling, you can either pass just `-R` (as in the example above, this will disable
the quit-if-one-screen feature), or you can use a recent version of `less` and pass `-RF` which
will hopefully enable both quit-if-one-screen and mouse-wheel scrolling.
If scrolling still doesn't work for you, you can try to pass the `-S` option in addition.
2018-11-11 14:28:18 +01:00
## Configuration file
2018-11-11 14:39:04 +01:00
`bat` can also be customized with a configuration file. The location of the file is dependent
on your operating system. To get the default path for your system, call
2018-11-11 11:07:38 +01:00
```
bat --config-file
```
2018-11-11 14:39:04 +01:00
Alternatively, you can use the `BAT_CONFIG_PATH` environment variable to point `bat` to a
non-default location of the configuration file:
2018-11-07 17:31:23 +01:00
```bash
2018-11-11 11:07:38 +01:00
export BAT_CONFIG_PATH="/path/to/bat.conf"
2018-11-07 17:31:23 +01:00
```
2018-11-11 14:28:18 +01:00
### Format
2018-11-11 11:07:38 +01:00
The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.
2018-11-11 11:07:38 +01:00
Example configuration file:
2018-11-07 17:31:23 +01:00
```bash
# Set the theme to "TwoDark"
--theme="TwoDark"
2018-11-07 17:31:23 +01:00
# Show line numbers, Git modifications and file header (but no grid)
--style="numbers,changes,header"
2018-11-11 12:17:15 +01:00
# Use italic text on the terminal (not supported on all terminals)
--italic-text=always
2018-11-07 17:31:23 +01:00
# Add mouse scrolling support in less (does not work with older
# versions of "less")
--pager="less -FR"
# Use C++ syntax (instead of C) for .h header files
--map-syntax h:cpp
# Use "gitignore" highlighting for ".ignore" files
--map-syntax .ignore:.gitignore
```
2018-09-08 10:31:33 +02:00
## Using `bat` on Windows
`bat` mostly works out-of-the-box on Windows, but a few features may need extra configuration.
### Paging
Windows only includes a very limited pager in the form of `more`. You can download a Windows binary
for `less` [from its homepage](http://www.greenwoodsoftware.com/less/download.html) or [through
Chocolatey](https://chocolatey.org/packages/Less). To use it, place the binary in a directory in
your `PATH` or [define an environment variable](#using-a-different-pager).
### Colours
Windows 10 natively supports colours in both `conhost.exe` (Command Prompt) and PowerShell since
[v1511](https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1511_(November_Update)), as
well as in newer versions of bash. On earlier versions of Windows, you can use
[Cmder](http://cmder.net/), which includes [ConEmu](https://conemu.github.io/).
**Note:** The Git and MSYS versions of `less` do not correctly interpret colours on Windows. If you
dont have any other pagers installed, you can disable paging entirely by passing `--paging=never`
or by setting `BAT_PAGER` to an empty string.
### Cygwin
2018-10-09 17:11:13 +02:00
`bat` on Windows does not natively support Cygwin's unix-style paths (`/cygdrive/*`). When passed an absolute cygwin path as an argument, `bat` will encounter the following error: `The system cannot find the path specified. (os error 3)`
This can be solved by creating a wrapper or adding the following function to your `.bash_profile` file:
```shell
bat() {
local index
local args=("$@")
for index in $(seq 0 ${#args[@]}) ; do
case "${args[index]}" in
-*) continue;;
*) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[index]}")";;
esac
done
command bat "${args[@]}"
}
```
2018-08-28 22:08:34 +02:00
## Troubleshooting
### Terminals & colors
`bat` handles terminals *with* and *without* truecolor support. However, the colors in the syntax
highlighting themes are not optimized for 8-bit colors and it is therefore strongly recommended
that you use a terminal with 24-bit truecolor support (`terminator`, `konsole`, `iTerm2`, ...).
See [this article](https://gist.github.com/XVilka/8346728) for more details and a full list of
terminals with truecolor support.
Make sure that your truecolor terminal sets the `COLORTERM` variable to either `truecolor` or
`24bit`. Otherwise, `bat` will not be able to determine whether or not 24-bit escape sequences
are supported (and fall back to 8-bit colors).
2018-09-03 22:12:41 +02:00
### Line numbers and grid are hardly visible
Please try a different theme (see `bat --list-themes` for a list). The `OneHalfDark` and
`OneHalfLight` themes provide grid and line colors that are brighter.
2018-08-28 21:03:03 +02:00
## Development
```bash
# Recursive clone to retrieve all submodules
git clone --recursive https://github.com/sharkdp/bat
# Build (debug version)
cd bat
cargo build
# Run unit tests and integration tests
cargo test
# Install (release version)
cargo install
# Build a bat binary with modified syntaxes and themes
bash assets/create.sh
cargo install -f
```
## Project goals and alternatives
`bat` tries to achieve the following goals:
- Provide beautiful, advanced syntax highlighting
- Integrate with Git to show file modifications
- Be a drop-in replacement for (POSIX) `cat`
- Offer a user-friendly command-line interface
There are a lot of alternatives, if you are looking for similar programs. See
[this document](doc/alternatives.md) for a comparison.