aw-watcher-tmux/README.md
2023-02-15 22:23:40 +01:00

1.9 KiB

aw-watcher-tmux - An activity watcher for tmux

A tmux plugin that allows monitoring activity in sessions and panes with ActivityWatch.

Watches for activity in multiple tmux sessions and reports session_name, window_name, pane_title, pane_current_command, and pane_current_path.

The plugin has been tested on Linux and is expected to work also on macOS and on Windows in Cygwin.

How to install

Requirements

macOS / Mac OSX

MacOS versions might still being shipped with bash versions < 4.0. In this case you will need to upgrade bash. In #2#issuecomment-1331496394 you can find instructions on how to upgrade bash via brew.

Preparation

  1. Install ActivityWatch as described in the getting-started guide.
  2. Install the Tmux Plugin Manager (tpm)

Install the aw-watcher-tmux plugin

  1. Add below line to your ~/.tmux.conf
set -g @plugin 'akohlbecker/aw-watcher-tmux'
  1. Press prefix + I (capital i, as in Install) to fetch the plugin and reload the tmux environment. More detailed instructions are found in the tpm README.

Usage

Once the aw-watcher-tmux plugin is installed it monitors for user activity in all tmux sessions. Any activity is reported to the ActivityWatch REST API at http://localhost:5600/api/.

aw-watcher-tmux creates a new bucket. The existence of this bucket can be checked with http://localhost:5600/api/0/buckets/aw-watcher-tmux.

All activity recorded in this bucket can be seen on http://localhost:5600/#/timeline