MrXcitement / zsh-bat

An oh-my-zsh plugin for integration with the bat pager.

zsh-bat

An oh-my-zsh plugin for integration with the bat pager.

This plugin provides a wrapper function for the bat command. The wrapper will use xtermcontrol if installed, to try to use a dark or light theme based on the current background color in the terminal.

Prerequisites

You should have bat installed, this plugin will do nothing otherwise. Install xtermcontrol and the plugin will attempt to pick a dark or light theme based on the background color of your terminal.

Install

Create a new directory in $ZSH_CUSTOM/plugins called zsh-bat and clone this repo into that directory.

git clone https://github.com/mrxcitement/zsh-bat.git $ZSH_CUSTOM/plugins/zsh-bat

Add zsh-bat to your plugin list in ~/.zshrc.

Usage

This plugin will alias cat with bat. To run the real cat command, you can use \cat. It also enables syntax highlighting for the man command.

To provide your own dark and/or light theme preference set one or both of the environment variables.

export BAT_THEME_DARK=OneHalfDark
export BAT_THEME_LIGHT=OneHalfLight

For help with bat, see sharkdp/bat.

Troubleshooting

If the dark light mode detection is not working, your terminal may not support xterm OSC codes.

• Do you have the xtermcontrol program installed and in your path?
• What does xtermcontrol --get-bg command return?
  • The return value should be a string with the following format: rgb:rrrr/gggg/bbbb
• What does the function _zsh_bat_get_background_brightness return?
  • The return value should be a string of either dark, light.
  • An empty string is returned if the background brightness can't be determined.
• What does the function _zsh_bat_get_theme return?
  • If BAT_THEME is defined, it should return it's value.
  • If _zsh_bat_get_background_brightness returned dark
    • If BAT_THEME_DARK is undefiened, it should return Monokai Extended
    • If BAT_THEME_DARK is defined, it should return it's value.
  • If _zsh_bat_get_background_brightness returned light
    • If BAT_THEME_LIGHT is undefiened, it should return Monokai Extended Light
    • If BAT_THEME_LIGHT is defined, it should return it's value.
  • If _zsh_bat_get_background_brightness returns an empty string.
    • It should return an empty string
• The selected theme will be provided using the --theme parameter.
  • To see what theme was selected run bat --diagnostics | head -n 20'
  • The Command-line section should show that the --theme= parameter was set.