Add instructions for syntax highlighting setup

Nitive · Jul 25, 2021 · 53aa5d7 · 53aa5d7
1 parent 5a58cd3
commit 53aa5d7
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -53,6 +53,15 @@ $ kubectl get node -o yaml | kgrep --show-status ker  # or kgrep -s ker
 .worker-2.status.nodeInfo.kernelVersion: 4.19.0-11-amd64
 ```
 
+## Syntax highlighting
+
+1. Install [bat](https://github.com/sharkdp/bat)
+2. Configure kgrep to pass it's output into `bat` via environment variable `KUBECTL_GREP_PASS_OUTPUT`
+   ```sh
+   # ~/.profile
+   export KUBECTL_GREP_PASS_OUTPUT="bat --language yaml --style plain --color always"
+   ```
+
 ## Installation
 
-Download latest release from releases page and but the binary in your PATH
+Download latest release from releases page and but the binary in your PATH