Skip to content

Document modules for supporting Wayland more clearly #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: 3.8
python-version: 3.12
- name: Install APT dependencies
run: |
sudo apt-get install -y git build-essential apt-utils wget libfreetype6 libpng-dev libopenblas-dev gcc gfortran libsnappy-dev
Expand Down
9 changes: 8 additions & 1 deletion src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Installation
Download the `latest release from GitHub <https://github.com/ActivityWatch/activitywatch/releases/latest>`_, unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications.

.. note::
If you are using Arch Linux you can install ActivityWatch directly from `the AUR <https://aur.archlinux.org/packages/activitywatch-bin/>`_.
If you are using Arch Linux you can install using the official ``activitywatch-bin`` package in `the AUR <https://aur.archlinux.org/packages/activitywatch-bin/>`_.

.. group-tab:: Android

Expand All @@ -33,6 +33,10 @@ Installation
.. note::
Getting it to F-droid is a work-in-progress, see `this PR <https://gitlab.com/fdroid/fdroiddata/-/merge_requests/5502>`_.

.. group-tab:: Source

If you prefer to build ActivityWatch from source, check out :doc:`this guide <installing-from-source>` instead.
Comment on lines +36 to +38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice



Usage
=====
Expand All @@ -48,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou
.. note::
If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`.

.. note::
If your Linux system is using Wayland rather than X11, the default watchers will not work. See :ref:`wayland watchers <wayland-watchers>`.

.. note::
If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this.

Expand Down
22 changes: 14 additions & 8 deletions src/watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,30 @@ Watchers

Watchers are the parts of ActivityWatch that do all the data collecting.

ActivityWatch comes with two watchers enabled by default:

.. _window-watchers:

Window watchers
-------------------------------------------

ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only):
Comment on lines +6 to +12
Copy link
Member

@ErikBjare ErikBjare May 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, a bit confusing to list aw-watcher-afk under this heading now (doesn't watch windows).

I figured we'd keep the intro and simple nest the Wayland watchers under a Window watchers subheading (underline with ~~~ to create a subheading).


- :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard).
- :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari).

These default watchers are collecting some of the most important data.
But there is more to collect, so here are some other watchers that let you do so.

.. _window-watchers:
.. _wayland-watchers:

Window watchers
---------------
Wayland watchers
-------------------------------------------

Watches the active window, its title, and application name.
Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`.

- :gh-aw:`aw-watcher-window` - The official window watcher for Windows, macOS, and Linux (X11 only).
- :gh-aw:`aw-watcher-window-wayland` - A window watcher for Wayland, by :gh-user:`johan-bjareholt`.
- :gh:`2e3s/awatcher` - A compiled watcher for X11 and Wayland to replace default window and AFK watchers, by :gh-user:`2e3s`.
- :gh-aw:`aw-watcher-window-wayland` - A window and idle watcher for Wayland, by :gh-user:`johan-bjareholt`, supports Posh, Sway.
- :gh:`2e3s/awatcher` - A compiled window and idle watcher for X11 and Wayland to replace default window and AFK watchers,
by :gh-user:`2e3s`, supports Sway, Hyprland, KDE, GNOME, and X11.

Browser watchers
----------------
Expand Down