fz0x1/aw-watcher-tmux
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more detailed installation and usage instructions

Browse source
This commit is contained in:
Andreas Kohlbecker 2021-05-24 10:58:05 +02:00
parent e84b08142c
commit 9a8e30f196
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -10,11 +10,13 @@ The plugin has been tested on Linux and is expected to work also on macOS and on
### Requirements
* [ActivityWatch](https://activitywatch.net)
* curl
### Preparation
Install the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (tpm) and install `akohlbecker/aw-watcher-tmux` as tmux plugin.
1. Install **ActivityWatch** as described in the [getting-started](https://docs.activitywatch.net/en/latest/getting-started.html#installation) guide.
2. Install the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (tpm)
### Install the aw-watcher-tmux plugin
@ -25,3 +27,11 @@ set -g @plugin 'akohlbecker/aw-watcher-tmux'
~~~
2. 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](https://github.com/tmux-plugins/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/](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](http://localhost:5600/api/0/buckets/aw-watcher-tmux).
All activity recorded in this bucket can be seen on [http://localhost:5600/#/timeline](http://localhost:5600/#/timeline)