BATGREP(1)

💖 NAME 💖

batgrep — Quickly search through and highlight files using ripgrep. That's the whole vibe, bestie. This is BATGREP(1) from the General Commands Manual, and we're about to break it all the way down. 🫶

✨ DESCRIPTION ✨

Okay so here's the tea: batgrep searches through files or directories looking for matching regular expressions (or fixed strings with -F), and prints the output using bat for an easy and syntax-highlighted experience. 💅✨

It's giving "search but make it pretty," and honestly? Obsessed. 🎀

🫶 USAGE 🫶

batgrep [OPTIONS] PATTERN [PATH...]

That's the shape of it: options first, then the pattern, then the paths. Slay. 🌸

💅 OPTIONS 💅

🌸 Options this script handles itself 🌸

• -i, --ignore-case — use case insensitive searching. It's not gonna be picky about uppercase vs. lowercase, bestie. 🦋
• -s, --case-sensitive — use case sensitive searching. Exact-case energy only. 💅
• -S, --smart-case — use smart case searching. The smartest little search vibe. ✨
• -A, --after-context=[LINES] — display the next n lines after a matched line. Peek after the match, periodt. 👀
• -B, --before-context=[LINES] — display the previous n lines before a matched line. Peek before the match, no cap. 🎀
• -C, --context=[LINES] — a combination of --after-context and --before-context. Both sides, bestie. 🫶
• -p, --search-pattern — tell pager to search for PATTERN. Currently supported pagers: less. 🧚
• --no-follow — do not follow symlinks. Leave those links where they are. 🚫
• --no-snip — do not show the snip decoration. This is automatically enabled when --context=0 or when bat --version is less than 0.12.x. 🎀
• --no-highlight — do not highlight matching lines. This is automatically enabled when --context=0. 💅
• --color — force color output. Make it pop. 🌈
• --no-color — force disable color output. Monochrome mode activated. 🖤
• --paging=["never"/"always"] — enable/disable paging. You either page or you don't, bestie. 📖
• --pager=[PAGER] — specify the pager to use. Put your fave in charge. 🫶
• --terminal-width=[COLS] — generate output for the specified terminal width. Fit the vibe to your window. 📐
• --no-separator — disable printing separator between files. No little divider moment. ✂️
• --rga — use ripgrep-all instead of ripgrep. A whole different search bestie. 🔥

🦋 Options passed directly to ripgrep 🦋

The following options are passed directly to ripgrep, and are not handled by this script. That's the rule, no cap. 🫶

• -F, --fixed-strings — passed straight through to ripgrep; no extra note in the table. 🦋
• -U, --multiline — passed straight through to ripgrep; no extra note in the table. 🌸
• -P, --pcre2 — passed straight through to ripgrep; no extra note in the table. ✨
• -z, --search-zip — passed straight through to ripgrep; no extra note in the table. 🎀
• -w, --word-regexp — passed straight through to ripgrep; no extra note in the table. 💅
• --one-file-system — passed straight through to ripgrep; no extra note in the table. 🌈
• --multiline-dotall — passed straight through to ripgrep; no extra note in the table. ⭐
• --ignore / --no-ignore — passed straight through to ripgrep; no extra note in the table. 🙈
• --crlf / --no-crlf — passed straight through to ripgrep; no extra note in the table. 🍓
• --hidden / --no-hidden — passed straight through to ripgrep; no extra note in the table. 👀
• -E, --encoding — passed straight through to ripgrep. ⚠️ This is unsupported by bat, and may cause issues when trying to display unsupported encodings. 😭
• -g, --glob — passed straight through to ripgrep; no extra note in the table. 🧚
• -t, --type — passed straight through to ripgrep; no extra note in the table. 💜
• -T, --type-not — passed straight through to ripgrep; no extra note in the table. 🦋
• -m, --max-count — passed straight through to ripgrep; no extra note in the table. 🔥
• --max-depth — passed straight through to ripgrep; no extra note in the table. 🌸
• --iglob — passed straight through to ripgrep; no extra note in the table. 🎀
• --ignore-file — passed straight through to ripgrep; no extra note in the table. ✨

🎀 CAVEATS 🎀

Differences from ripgrep, bestie:

• --follow is enabled by default for batgrep. 👀
• Not all the ripgrep options are supported. Periodt. 💅

That's the whole BATGREP(1) page from the General Commands Manual, bestie. 🫶 The footer vibe is just BATGREP(1) again, and there's no separate source/version/date line to copy in the original, so we're not inventing one — periodt. 💅✨