Awesome

hwatch

hwatch - alternative watch command.

Description

hwatch is a alternative watch command. That records the result of command execution and can display it history and diffs.

Features

• Can keep the history when the difference, occurs and check it later.
• Can check the difference in the history. The display method can be changed in real time.
• Can output the execution result as log (json format).
• Custom keymaps are available.
• Support ANSI color code.
• Execution result can be scroll.
• Not only as a TUI application, but also to have the differences output as standard output.
• If a difference occurs, you can have the specified command additionally executed.

Install

macOS (brew)

brew install hwatch

macOS (MacPorts)

sudo port install hwatch

Arch Linux (AUR)

paru -S hwatch

Cargo Install

cargo install hwatch

Usage

Command

    $ hwatch --help
    A modern alternative to the watch command, records the differences in execution results and can check this differences at after.

    Usage: hwatch [OPTIONS] [command]...

    Arguments:
      [command]...

    Options:
      -b, --batch                         output execution results to stdout
      -B, --beep                          beep if command has a change result
          --border                        Surround each pane with a border frame
          --with-scrollbar                When the border option is enabled, display scrollbar on the right side of watch pane.
          --mouse                         enable mouse wheel support. With this option, copying text with your terminal may be harder. Try holding the Shift key.
      -c, --color                         interpret ANSI color and style sequences
      -r, --reverse                       display text upside down.
      -C, --compress                      Compress data in memory. Note: If the output of the command is small, you may not get the desired effect.
      -t, --no-title                      hide the UI on start. Use `t` to toggle it.
      -N, --line-number                   show line number
          --no-help-banner                hide the "Display help with h key" message
      -x, --exec                          Run the command directly, not through the shell. Much like the `-x` option of the watch command.
      -O, --diff-output-only              Display only the lines with differences during `line` diff and `word` diff.
      -A, --aftercommand <after_command>  Executes the specified command if the output changes. Information about changes is stored in json format in environment variable ${HWATCH_DATA}.
      -l, --logfile [<logfile>]           logging file. if a log file is already used, its contents will be read and executed.
      -s, --shell <shell_command>         shell to use at runtime. can also insert the command to the location specified by {COMMAND}. [default: "sh -c"]
      -n, --interval <interval>           seconds to wait between updates [default: 2]
      -L, --limit <limit>                 Set the number of history records to keep. only work in watch mode. Set `0` for unlimited recording. (default: 5000) [default: 5000]
          --tab-size <tab_size>           Specifying tab display size [default: 4]
      -d, --differences [<differences>]   highlight changes between updates [possible values: none, watch, line, word]
      -o, --output [<output>]             Select command output. [default: output] [possible values: output, stdout, stderr]
      -K, --keymap <keymap>               Add keymap
      -h, --help                          Print help
      -V, --version                       Print version

Keybind

Watch mode keybind(Default).

Custom keybind

Can customize key bindings by using the -K Option. Write it in the format keybind=funciton.

hwatch -K ctrl-p=history_pane_up -K ctrl-n=history_pane_down command...

Keybind functions that can be specified are as follows.

Configuration

If you always want to use some command-line options, you can set them in the HWATCH environment variable. For example, if you use bash, you can add the following to your .bashrc:

export HWATCH="--no-title --color --no-help-banner --border --with-scrollbar"

Example

interval 10 second

Use the -n option to specify the command execution interval.

hwatch -n 3 command...

logging output

The command execution result can be output as a log in json format.

hwatch -n 3 -l hwatch_log.json command...

When you check the json log, you can easily check it by using this script.

Use shell function

If you want the shell function to be executed periodically, you can specify the shell command to be executed with -s as follows.

# bash
hwatch -n 3 -s 'bash -c "source ~/.bashrc"; {COMMAND}' command...

# zsh
hwatch -n 3 -s 'zsh -c "source ~/.zshrc"; {COMMAND}' command...

ANSI Color code

If you want to see output colored with ANSI color code, enable color mode.

To enable color mode, run hwatch with the -c option. Alternatively, you can enable / disable the color mode with the <kbd>C</kbd> key during execution.

hwatch -n 3 -c command...

diff view

To enable color mode, run hwatch with the -d option.

There are several "diff modes" available. Switching can be done with the <kbd>D</kbd> key.

hwatch -n 3 -d command...

watch diff

line diff

word diff

history filtering

You can filter history as a string with <kbd>/</kbd> key and as a regular expression with <kbd>*</kbd> key.

run batch mode

You can have command diffs output directly to stdout instead with -b option of getting them as a TUI app.

hwatch -b command...

Alternatives

• The original watch; the newest version seems to be distributed as a part of procps.
• Viddy.
• sasqwatch