2019-06-19 23:15:10 +02:00
# bat-extras: batgrep
A script that combines [ripgrep ](https://github.com/burntsushi/ripgrep ) with bat's syntax highlighting and output formatting.
## Command Line
**Synopsis:**
- `batgrep [OPTIONS] PATTERN [PATH...] `
**Options:**
2019-09-18 23:20:04 +02:00
| Short | Long | Description |
| ----- | -------------------------- | ------------------------------------------------------------ |
| `-i` | `--ignore-case` | Use case insensitive searching. |
2019-12-24 01:50:56 +01:00
| `-s` | `--case-sensitive` | Use case sensitive searching. |
| `-S` | `--smart-case` | Use smart case searching. |
2019-09-18 23:20:04 +02:00
| `-A` | `--after-context=[LINES]` | Display the next *n* lines after a matched line. |
| `-B` | `--before-context=[LINES]` | Display the previous `n` lines before a matched line. |
| `-C` | `--context=[LINES]` | A combination of `--after-context` and `--before-context` . |
2020-01-18 05:44:58 +01:00
| `-p` | `--search-pattern` | Tell pager to search for `PATTERN` . Currently supported pagers: `less` . |
2019-09-18 23:20:04 +02:00
| | `--no-follow` | Do not follow symlinks. |
2019-09-19 06:12:23 +02:00
| | `--no-snip` | Do not show the `snip` decoration.< br />< br /> This is automatically enabled when `--context=0` or when `bat --version` is less than `0.12.x` . |
| | `--no-highlight` | Do not highlight matching lines.< br />< br /> This is automatically enabled when `--context=0` . |
2019-09-24 21:11:54 +02:00
| | `--color` | Force color output. |
| | `--no-color` | Force disable color output. |
2019-06-19 23:15:10 +02:00
**Options (Passthrough)**:
The following options are passed directly to ripgrep, and are not handled by this script.
| Short | Long | Notes |
| ----- | -------------------------- | ------------------------------------------------------------ |
| `-F` | `--fixed-strings` | |
| `-U` | `--multiline` | |
| `-P` | `--pcre2` | |
| `-z` | `--search-zip` | |
| `-w` | `--word-regexp` | |
| | `--one-file-system` | |
| | `--multiline-dotall` | |
| | `--ignore` / `--no-ignore` | |
| | `--crlf` / `--no-crlf` | |
| | `--hidden` / `--no-hidden` | |
| `-E` | `--encoding` | This is unsupported by `bat` , and may cause issues when trying to display unsupported encodings. |
| `-g` | `--glob` | |
| `-t` | `--type` | |
| `-T` | `--type-not` | |
| `-m` | `--max-count` | |
| | `--max-depth` | |
| | `--iglob` | |
| | `--ignore-file` | |
2019-09-18 23:15:45 +02:00
## Installation
This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here ](../README.md#installation ).
2019-06-19 23:15:10 +02:00
## Caveats
**Differences from ripgrep:**
- `--follow` is enabled by default for `batgrep` .
- Not all the `ripgrep` options are supported.
## Issues?
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
2020-01-18 05:44:58 +01:00
Contributions are always welcome.
