bat-extras/doc/batwatch.md
2023-03-20 22:36:49 -07:00

1.7 KiB

bat-extras: batwatch

Watch for changes in files or command output, and print them with bat.

Usage

batwatch [OPTIONS] FILE...

batwatch [OPTIONS] --command COMMAND [ARG...]

Options

Short Long Description
--command|-x Execute a command on an interval.
--file|-f Watch a file for changes.
--watcher=[watcher] Use a specific program to watch for file changes. See below for more details.
--interval=[seconds] The interval for executing commands.
--clear Clear the screen before printing the files.
This is enabled by default.
--no-clear Do not clear the screen before printing the files.
--color Force color output.
--no-color Force disable color output.

All remaining options are passed through to bat.

Watchers

Batwatch uses external programs to watch for file changes. Currently, the following programs are supported:

There is also a fallback poll watcher available.

Installation

This script is a part of the bat-extras suite of scripts. You can find install instructions here.

Issues?

If you find an issue or have a feature suggestion, make a pull request or issue through GitHub! Contributions are always welcome.