activitywatch README

The project's README from github.com/ActivityWatch/activitywatch. As one markdown file: README.md.

Records what you do so that you can know how you've spent your time.
All in a secure way where you control the data.


Website — Forum — Documentation — Releases
Contributor stats — CI overview



Do you want to receive email updates on major announcements?
Signup for the newsletter!

Table of Contents

About

The goal of ActivityWatch is simple: Enable the collection of as much valuable lifedata as possible without compromising user privacy.

We've worked towards this goal by creating an application for safe storage of the data on the user's local machine and as well as a set of watchers which record data such as:

It is up to you as user to collect as much as you want, or as little as you want (and we hope some of you will help write watchers so we can collect more).

Screenshots

You can find more (and newer) screenshots on the website.

Installation & Usage

Downloads are available on the releases page.

For instructions on how to get started, please see the guide in the documentation.

Interested in building from source? There's a guide for that too.

Is this yet another time tracker?

Yes, but we found that most time trackers lack one or more important features.

Common dealbreakers:

To sum it up:

We have a plan to address all of these and we're well on our way. See the table below for our progress.

Feature comparison

Basics
User owns data GUI Sync Open Source
ActivityWatch :white_check_mark: :white_check_mark: WIP, decentralized :white_check_mark:
Selfspy :white_check_mark: :x: :x: :white_check_mark:
ulogme :white_check_mark: :white_check_mark: :x: :white_check_mark:
RescueTime :x: :white_check_mark: Centralized :x:
WakaTime :x: :white_check_mark: Centralized Clients
Platforms
Windows macOS Linux Android iOS
ActivityWatch :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark: :x:
Selfspy :white_check_mark: :white_check_mark: :white_check_mark: :x: :x:
ulogme :x: :white_check_mark: :white_check_mark: :x: :x:
RescueTime :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark: Limited functionality
Tracking
App & Window Title AFK Browser Extensions Editor Plugins Extensible
ActivityWatch :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark:
Selfspy :white_check_mark: :white_check_mark: :x: :x: :x:
ulogme :white_check_mark: :white_check_mark: :x: :x: :x:
RescueTime :white_check_mark: :white_check_mark: :white_check_mark: :x: :x:
WakaTime :x: :white_check_mark: :white_check_mark: :white_check_mark: Only for text editors

For a complete list of the things ActivityWatch can track, see the page on watchers in the documentation.

Architecture

graph TD;
  aw-qt[<a href='https://github.com/ActivityWatch/aw-qt'>aw-qt</a>];
  aw-notify[<a href='https://github.com/ActivityWatch/aw-notify-rs'>aw-notify</a>];
  aw-server[<a href='https://github.com/ActivityWatch/aw-server'>aw-server</a>];
  aw-webui[<a href='https://github.com/ActivityWatch/aw-webui'>aw-webui</a>];
  aw-watcher-window[<a href='https://github.com/ActivityWatch/aw-watcher-window'>aw-watcher-window</a>];
  aw-watcher-afk[<a href='https://github.com/ActivityWatch/aw-watcher-afk'>aw-watcher-afk</a>];
  aw-watcher-web[<a href='https://github.com/ActivityWatch/aw-watcher-web'>aw-watcher-web</a>];
  aw-sync[<a href='https://github.com/ActivityWatch/aw-server-rust/tree/master/aw-sync'>aw-sync</a>];

  aw-qt -- Manages --> aw-server;
  aw-qt -- Manages --> aw-notify -- Queries --> aw-server;
  aw-qt -- Manages --> aw-watcher-window -- Watches --> S1[Active window] -- Heartbeats --> aw-server;
  aw-qt -- Manages --> aw-watcher-afk -- Watches --> S2[AFK status] -- Heartbeats --> aw-server;
  Browser -- Manages --> aw-watcher-web -- Watches --> S3[Active tab] -- Heartbeats --> aw-server;
  SF -- Dropbox/Syncthing/etc --> SF;
  aw-server <-- Push/Pull --> aw-sync <-- Read/Write --> SF[Sync folder];
  aw-server -- Serves --> aw-webui -- Queries --> aw-server;

  %% User -- Interacts --> aw-webui;
  %% User -- Observes --> aw-notify;
  %% User -- Interacts --> aw-qt;

classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333;
classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF;

classDef lightModeLinks stroke:#333333;
classDef darkModeLinks stroke:#FFFFFF;

class A,B,C,D,E,G lightMode;
class A,B,C,D,E,G darkMode;

%% linkStyle 0 stroke:#FF4136, stroke-width:2px;
%% linkStyle 1 stroke:#1ABC9C, stroke-width:2px;

About this repository

This repo is a bundle of the core components and official modules of ActivityWatch (managed with git submodule). Its primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. It is also where releases of the full suite are published (see releases).

Server

ActivityWatch has two server implementations:

Both provide a REST API to a datastore and query engine, and serve the web interface developed in the aw-webui project (which provides the frontend).

The REST API includes:

The frontend (aw-webui) includes:

Watchers

ActivityWatch comes pre-installed with two watchers:

There are lots of other watchers for ActivityWatch which can track more types of activity. Like aw-watcher-web which tracks time spent on websites, multiple editor watchers which track spent time coding, and many more! A full list of watchers can be found in the documentation.

Libraries

Folder structure

Contributing

Want to help? Great! Check out the CONTRIBUTING.md file!

Questions and support

Have a question, suggestion, problem, or just want to say hi? Post on the forum!

activitywatch (ActivityWatch/activitywatch)

Searching Database…

19.3K ·GitHub
Activitywatch
Что это такое?ActivityWatch — это бесплатный автоматический трекер времени с открытым исходным кодом. Он записывает, какими приложениями и сайтами вы пользуетесь и насколько активны, хранит данные на вашем компьютере и показывает их в панели, чтобы вы видели, на что на самом деле уходит ваше время.
Что именно он обо мне записывает?Текущее активное приложение и заголовок его окна, вкладки браузера с их названиями и URL, а также активность клавиатуры и мыши — по последней он определяет, что вас нет за компьютером. Дополнительные вотчеры могут собирать и другие данные.
Как его запустить?Скачайте сборку для своей ОС со страницы релизов и следуйте руководству по началу работы в документации. В релизах входит весь готовый к работе набор; сам же этот репозиторий — мета-пакет из git-субмодулей, нужный в основном для упаковки и сборки из исходников.
Нужен ли аккаунт или какой-то онлайн-сервис?Нет — регистрироваться негде, облачные сервисы не задействованы, весь стек работает на вашем компьютере. Единственные дополнительные установки — необязательные вотчеры для браузера и редактора кода, если двух встроенных вам мало.
Можно ли пользоваться им на нескольких устройствах?Пока нет: синхронизация ещё в разработке, причём планируется сделать её децентрализованной, чтобы данные не видел никакой центральный сервер. Пока считайте его трекером для одного компьютера.
На каких платформах он работает?Windows, macOS, Linux и Android. iOS не поддерживается — таблица платформ в README помечает её как недоступную для ActivityWatch.
Мои данные когда-нибудь покидают компьютер?Нет. Данные пишутся в локальное хранилище и принадлежат вам — это и есть заявленная цель проекта: собирать как можно больше данных о жизни, не жертвуя приватностью пользователя.
Чем он отличается от RescueTime или WakaTime?Это закрытые сервисы, которые хранят ваши данные на своих серверах. ActivityWatch полностью открыт, данные лежат у вас локально, планируемая синхронизация децентрализована, а не централизована, и он хранит сырые события, а не грубые сводки.
Что мне показывает панель?Интерфейс в браузере с таймлайном и сводками активности по приложениям, сайтам и заданным вами категориям, плюс проводник запросов для написания и отладки запросов, просмотр сырых событий и экспорт в JSON отдельных бакетов или всего набора данных.
Можно ли расширять его или строить поверх свои инструменты?Да. Локальный сервер предоставляет REST API — бакеты, события, хартбиты и небольшой скриптовый язык запросов — с официальными клиентскими библиотеками для Python, JavaScript и Rust. Писать новые вотчеры на основе aw-core и aw-client — задуманный способ отслеживать больше.
What are similar projects?super-productivity, agentsview, wordcraft, Dayflow, AI-Engineering-Coach, gridcraft, redash, taskview-community
Which topics is it in?time-tracker, open-source-alternative, browser-extension, analytics, app, data-visualization, offline, dashboard, monitoring, local-first, rest-api, mobile
Creator
ActivityWatch
Size
1.8 MB
Stars
19.3K
Updated
CommitOct 16Releasev0.14.1Oct 10
Age
10y
Commits · 90 Days