1 2 3<!DOCTYPE html> 4<html class="writer-html5" lang="en" data-content_root="./"> 5<head> 6 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> 7 8 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 9 <title>Welcome to the ActivityWatch documentation!</title> 10 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> 11 <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" /> 12 <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" /> 13 <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=cfa24e5f" /> 14 15 16 <link rel="shortcut icon" href="_static/logo.ico"/> 17
17<script src="_static/jquery.js?v=5d32c60e"></script>
17 18
18<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18 19
19<script src="_static/documentation_options.js?v=1f4bf607"></script>
19 20
20<script src="_static/doctools.js?v=9bcbadda"></script>
20 21
21<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
21 22
22<script src="_static/js/theme.js"></script>
22 23 <link rel="index" title="Index" href="genindex.html" /> 24 <link rel="search" title="Search" href="search.html" /> 25 <link rel="next" title="Introduction" href="introduction.html" />
26<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
26<meta name="readthedocs-project-slug" content="activitywatch" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> 27 28<body class="wy-body-for-nav"> 29 <div class="wy-grid-for-nav"> 30 <nav data-toggle="wy-nav-shift" class="wy-nav-side"> 31 <div class="wy-side-scroll"> 32 <div class="wy-side-nav-search" > 33 34 35 36 <a href="#" class="icon icon-home"> 37 ActivityWatch 38 <img src="_static/banner.png" class="logo" alt="Logo"/> 39 </a> 40<div role="search"> 41 <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> 42 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> 43 <input type="hidden" name="check_keywords" value="yes" /> 44 <input type="hidden" name="area" value="default" /> 45 </form> 46</div> 47 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> 48 <p class="caption" role="heading"><span class="caption-text">User documentation</span></p> 49<ul> 50<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul> 51<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-activitywatch">What is ActivityWatch?</a></li> 52<li class="toctree-l2"><a class="reference internal" href="introduction.html#reason-for-existence">Reason for existence</a></li> 53<li class="toctree-l2"><a class="reference internal" href="introduction.html#data-philosophy">Data philosophy</a></li> 54</ul> 55</li> 56<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul> 57<li class="toctree-l2"><a class="reference internal" href="getting-started.html#installation">Installation</a></li> 58<li class="toctree-l2"><a class="reference internal" href="getting-started.html#usage">Usage</a></li> 59<li class="toctree-l2"><a class="reference internal" href="getting-started.html#autostart">Autostart</a></li> 60</ul> 61</li> 62<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul> 63<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-server-python">aw-server-python</a></li> 64<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-server-rust">aw-server-rust</a></li> 65<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-client">aw-client</a></li> 66<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-watcher-afk">aw-watcher-afk</a></li> 67<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-watcher-window">aw-watcher-window</a></li> 68</ul> 69</li> 70<li class="toctree-l1"><a class="reference internal" href="directories.html">Directories</a><ul> 71<li class="toctree-l2"><a class="reference internal" href="directories.html#data">Data</a></li> 72<li class="toctree-l2"><a class="reference internal" href="directories.html#config">Config</a></li> 73<li class="toctree-l2"><a class="reference internal" href="directories.html#logs">Logs</a></li> 74<li class="toctree-l2"><a class="reference internal" href="directories.html#cache">Cache</a></li> 75</ul> 76</li> 77<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a><ul> 78<li class="toctree-l2"><a class="reference internal" href="features/user-interface.html">User Interface</a><ul> 79<li class="toctree-l3"><a class="reference internal" href="features/user-interface.html#web-interface">Web Interface</a></li> 80<li class="toctree-l3"><a class="reference internal" href="features/user-interface.html#tray-icon">Tray icon</a></li> 81</ul> 82</li> 83<li class="toctree-l2"><a class="reference internal" href="features/exporting-data.html">Exporting data</a></li> 84<li class="toctree-l2"><a class="reference internal" href="features/pausing-logging.html">Pausing logging</a></li> 85<li class="toctree-l2"><a class="reference internal" href="features/filtering-data.html">Filtering data</a></li> 86<li class="toctree-l2"><a class="reference internal" href="features/categorization.html">Categorization</a><ul> 87<li class="toctree-l3"><a class="reference internal" href="features/categorization.html#adding-and-editing-categories">Adding and editing categories</a></li> 88<li class="toctree-l3"><a class="reference internal" href="features/categorization.html#rules">Rules</a><ul> 89<li class="toctree-l4"><a class="reference internal" href="features/categorization.html#regular-expressions-regex">Regular expressions (RegEx)</a></li> 90<li class="toctree-l4"><a class="reference internal" href="features/categorization.html#no-rule">No rule</a></li> 91</ul> 92</li> 93</ul> 94</li> 95<li class="toctree-l2"><a class="reference internal" href="features/syncing.html">Syncing</a><ul> 96<li class="toctree-l3"><a class="reference internal" href="features/syncing.html#old-syncing-prototype">Old syncing prototype</a></li> 97</ul> 98</li> 99</ul> 100</li> 101<li class="toctree-l1"><a class="reference internal" href="watchers.html">Watchers</a><ul> 102<li class="toctree-l2"><a class="reference internal" href="watchers.html#window-watchers">Window watchers</a></li> 103<li class="toctree-l2"><a class="reference internal" href="watchers.html#browser-watchers">Browser watchers</a></li> 104<li class="toctree-l2"><a class="reference internal" href="watchers.html#editor-watchers">Editor watchers</a></li> 105<li class="toctree-l2"><a class="reference internal" href="watchers.html#media-watchers">Media watchers</a></li> 106<li class="toctree-l2"><a class="reference internal" href="watchers.html#other-watchers">Other watchers</a></li> 107<li class="toctree-l2"><a class="reference internal" href="watchers.html#importers">Importers</a></li> 108<li class="toctree-l2"><a class="reference internal" href="watchers.html#custom-visualizations">Custom visualizations</a></li> 109<li class="toctree-l2"><a class="reference internal" href="watchers.html#custom-watchers">Custom watchers</a></li> 110</ul> 111</li> 112<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul> 113<li class="toctree-l2"><a class="reference internal" href="faq.html#general">General</a><ul> 114<li class="toctree-l3"><a class="reference internal" href="faq.html#what-is-activitywatch">What is ActivityWatch?</a></li> 115<li class="toctree-l3"><a class="reference internal" href="faq.html#is-activitywatch-really-free">Is ActivityWatch really free?</a></li> 116<li class="toctree-l3"><a class="reference internal" href="faq.html#what-platforms-does-activitywatch-support">What platforms does ActivityWatch support?</a></li> 117<li class="toctree-l3"><a class="reference internal" href="faq.html#does-activitywatch-track-my-data-privately">Does ActivityWatch track my data privately?</a></li> 118<li class="toctree-l3"><a class="reference internal" href="faq.html#where-is-my-data-stored">Where is my data stored?</a></li> 119<li class="toctree-l3"><a class="reference internal" href="faq.html#how-does-activitywatch-compare-to-rescuetime">How does ActivityWatch compare to RescueTime?</a></li> 120<li class="toctree-l3"><a class="reference internal" href="faq.html#can-i-extend-activitywatch-with-custom-tracking">Can I extend ActivityWatch with custom tracking?</a></li> 121</ul> 122</li> 123<li class="toctree-l2"><a class="reference internal" href="faq.html#technical">Technical</a><ul> 124<li class="toctree-l3"><a class="reference internal" href="faq.html#how-do-i-interpret-the-raw-data">How do I interpret the raw data?</a></li> 125<li class="toctree-l3"><a class="reference internal" href="faq.html#how-can-i-use-activitywatch-with-my-own-code">How can I use ActivityWatch with my own code?</a></li> 126<li class="toctree-l3"><a class="reference internal" href="faq.html#how-does-activitywatch-know-when-i-am-afk">
126How does ActivityWatch know when I am AFK?</a></li> 127<li class="toctree-l3"><a class="reference internal" href="faq.html#can-i-change-when-activitywatch-marks-me-as-afk">Can I change when ActivityWatch marks me as AFK?</a></li> 128<li class="toctree-l3"><a class="reference internal" href="faq.html#why-is-the-active-window-logged-as-unknown-when-using-wayland">Why is the active window logged as âunknownâ when using Wayland?</a></li> 129<li class="toctree-l3"><a class="reference internal" href="faq.html#how-accurate-is-activitywatch">How accurate is ActivityWatch?</a></li> 130<li class="toctree-l3"><a class="reference internal" href="faq.html#what-happens-if-it-is-down-or-crashes">What happens if it is down or crashes?</a></li> 131<li class="toctree-l3"><a class="reference internal" href="faq.html#some-events-have-0-duration-what-does-this-mean">Some events have 0 duration. What does this mean?</a></li> 132</ul> 133</li> 134</ul> 135</li> 136<li class="toctree-l1"><a class="reference internal" href="syncing.html">Syncing</a><ul> 137<li class="toctree-l2"><a class="reference internal" href="syncing.html#android">Android</a></li> 138<li class="toctree-l2"><a class="reference internal" href="syncing.html#how-to-set-up-syncing">How to set up syncing</a></li> 139</ul> 140</li> 141<li class="toctree-l1"><a class="reference internal" href="migrating.html">Migrating</a><ul> 142<li class="toctree-l2"><a class="reference internal" href="migrating.html#migrating-to-aw-server-rust">Migrating to aw-server-rust</a><ul> 143<li class="toctree-l3"><a class="reference internal" href="migrating.html#using-aw-server-rust-by-default">Using aw-server-rust by default</a></li> 144<li class="toctree-l3"><a class="reference internal" href="migrating.html#importing-from-aw-server-python">Importing from aw-server-python</a></li> 145</ul> 146</li> 147<li class="toctree-l2"><a class="reference internal" href="migrating.html#database-schema-migrations">Database schema migrations</a></li> 148</ul> 149</li> 150<li class="toctree-l1"><a class="reference internal" href="running-on-gnome.html">Running on GNOME</a></li> 151<li class="toctree-l1"><a class="reference internal" href="remote-server.html">Remote server</a><ul> 152<li class="toctree-l2"><a class="reference internal" href="remote-server.html#but-then-how-do-i-get-all-my-data-in-one-place">But then how do I get all my data in one place?</a></li> 153<li class="toctree-l2"><a class="reference internal" href="remote-server.html#i-know-what-i-m-doing-how-can-i-set-it-up-anyway">I know what Iâm doing, how can I set it up anyway?</a><ul> 154<li class="toctree-l3"><a class="reference internal" href="remote-server.html#ssh-tunnel">SSH tunnel</a></li> 155<li class="toctree-l3"><a class="reference internal" href="remote-server.html#opening-the-server-to-the-network">Opening the server to the network</a></li> 156</ul> 157</li> 158<li class="toctree-l2"><a class="reference internal" href="remote-server.html#previous-discussions">Previous discussions</a></li> 159</ul> 160</li> 161<li class="toctree-l1"><a class="reference internal" href="updating.html">Updating</a><ul> 162<li class="toctree-l2"><a class="reference internal" href="updating.html#macos">macOS</a></li> 163</ul> 164</li> 165<li class="toctree-l1"><a class="reference internal" href="uninstalling.html">Uninstalling</a><ul> 166<li class="toctree-l2"><a class="reference internal" href="uninstalling.html#removing-data">Removing data</a></li> 167</ul> 168</li> 169</ul> 170<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p> 171<ul> 172<li class="toctree-l1"><a class="reference internal" href="installing-from-source.html">Installing from source</a><ul> 173<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#cloning-the-repository-and-submodules">Cloning the repository and submodules</a></li> 174<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#checking-dependencies">Checking dependencies</a></li> 175<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#using-a-virtualenv">Using a virtualenv</a></li> 176<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#building-and-installing">Building and installing</a></li> 177<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#running">Running</a></li> 178<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#updating-from-source">Updating from source</a></li> 179<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#packaging-your-changes">Packaging your changes</a></li> 180</ul> 181</li> 182<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI Usage</a><ul> 183<li class="toctree-l2"><a class="reference internal" href="cli.html#aw-client">
183aw-client</a></li> 184<li class="toctree-l2"><a class="reference internal" href="cli.html#not-yet-documented">Not yet documented</a></li> 185</ul> 186</li> 187<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a><ul> 188<li class="toctree-l2"><a class="reference internal" href="architecture.html#dependency-graph">Dependency graph</a></li> 189<li class="toctree-l2"><a class="reference internal" href="architecture.html#server">Server</a></li> 190<li class="toctree-l2"><a class="reference internal" href="architecture.html#clients-watchers-importers-and-observers">Clients (watchers, importers, and observers)</a></li> 191<li class="toctree-l2"><a class="reference internal" href="architecture.html#user-interfaces">User interfaces</a></li> 192<li class="toctree-l2"><a class="reference internal" href="architecture.html#libraries">Libraries</a><ul> 193<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-core">aw-core</a></li> 194<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-client">aw-client</a></li> 195<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-analysis">aw-analysis</a></li> 196</ul> 197</li> 198</ul> 199</li> 200<li class="toctree-l1"><a class="reference internal" href="buckets-and-events.html">Data model</a><ul> 201<li class="toctree-l2"><a class="reference internal" href="buckets-and-events.html#buckets">Buckets</a></li> 202<li class="toctree-l2"><a class="reference internal" href="buckets-and-events.html#events">Events</a><ul> 203<li class="toctree-l3"><a class="reference internal" href="buckets-and-events.html#heartbeats">Heartbeats</a></li> 204<li class="toctree-l3"><a class="reference internal" href="buckets-and-events.html#event-types">Event types</a><ul> 205<li class="toctree-l4"><a class="reference internal" href="buckets-and-events.html#web-tab-current">web.tab.current</a></li> 206<li class="toctree-l4"><a class="reference internal" href="buckets-and-events.html#app-editor-activity">app.editor.activity</a></li> 207<li class="toctree-l4"><a class="reference internal" href="buckets-and-events.html#currentwindow">currentwindow</a></li> 208<li class="toctree-l4"><a class="reference internal" href="buckets-and-events.html#afkstatus">afkstatus</a></li> 209</ul> 210</li> 211</ul> 212</li> 213</ul> 214</li> 215<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul> 216<li class="toctree-l2"><a class="reference internal" href="examples.html#getting-your-data-out">Getting Your Data Out</a><ul> 217<li class="toctree-l3"><a class="reference internal" href="examples/working-with-data.html">Working with ActivityWatch Data</a><ul> 218<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#getting-started-canonical-events">Getting Started: Canonical Events</a></li> 219<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#comprehensive-examples">Comprehensive Examples</a></li> 220<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#custom-queries">Custom Queries</a></li> 221<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#raw-events-advanced">Raw Events (Advanced)</a></li> 222<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#exporting-data">Exporting Data</a></li> 223<li class="toctree-l4"><a class="reference internal" href="examples/working-with-data.html#api-reference">API Reference</a></li> 224</ul> 225</li> 226<li class="toctree-l3"><a class="reference internal" href="examples/agents-and-ai.html">ActivityWatch with agents and AI</a><ul> 227<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#recommended-workflow">Recommended workflow</a></li> 228<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#get-canonical-activity">Get canonical activity</a></li> 229<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#compact-context-example">Compact context example</a></li> 230<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#sensitive-fields">Sensitive fields</a></li> 231<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#local-first-workflow">Local-first workflow</a></li> 232<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#agent-and-tool-workflow">Agent and tool workflow</a></li> 233<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#third-party-provider-upload">Third-party provider upload</a></li> 234<li class="toctree-l4"><a class="reference internal" href="examples/agents-and-ai.html#related-docs">Related docs</a></li> 235</ul> 236</li> 237</ul> 238</li> 239<li class="toctree-l2"><a class="reference internal" href="examples.html#writing-your-own-watchers">Writing Your Own Watchers</a><ul> 240<li class="toctree-l3"><a class="reference internal" href="examples/writing-watchers.html">Writing your first watcher in Python</a><ul> 241<li class="toctree-l4"><a class="reference internal" href="examples/writing-watchers.html#minimal-client">Minimal client</a></li> 242<li class="toctree-l4"><a class="reference internal" href="examples/writing-watchers.html#reference-client">Reference client</a></li> 243</ul> 244</li> 245<li class="toctree-l3"><a class="reference internal" href="examples/writing-watchers.html#writing-your-first-watcher-in-rust">Writing your first watcher in Rust</a><ul> 246<li class="toctree-l4"><a class="reference internal" href="examples/writing-watchers.html#id1">Minimal client</a></li> 247<li class="toctree-l4"><a class="reference internal" href="examples/writing-watchers.html#id2">Reference client</a></li> 248</ul> 249</li> 250</ul> 251</li> 252<li class="toctree-l2"><a class="reference internal" href="examples.html#example-code-repository">Example Code Repository</a></li> 253</ul> 254</li> 255<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a><ul> 256<li class="toctree-l2"><a class="reference internal" href="api/python.html">API Reference (Python)</a><ul> 257<li class="toctree-l3"><a class="reference internal" href="api/python.html#module-aw_core">aw_core</a><ul> 258<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_core.Event"><code class="docutils literal notranslate"><span class="pre">Event</span></code></a></li> 259<li class="toctree-l4"><a class="reference internal" href="api/python.html#module-aw_core.models">aw_core.models</a></li> 260<li class="toctree-l4"><a class="reference internal" href="api/python.html#module-aw_core.log">aw_core.log</a></li> 261<li class="toctree-l4"><a class="reference internal" href="api/python.html#module-aw_core.dirs">aw_core.dirs</a></li> 262</ul> 263</li> 264<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-client">aw_client</a><ul> 265<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_client.ActivityWatchClient"><code class="docutils literal notranslate"><span class="pre">ActivityWatchClient</span></code></a></li> 266</ul> 267</li> 268<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-transform">aw_transform</a><ul> 269<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.Rule"><code class="docutils literal notranslate"><span class="pre">Rule</span></code></a></li> 270<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.categorize"><code class="docutils literal notranslate"><span class="pre">categorize()</span></code></a></li> 271<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.chunk_events_by_key"><code class="docutils literal notranslate"><span class="pre">chunk_events_by_key()</span></code></a></li> 272<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.concat"><code class="docutils literal notranslate"><span class="pre">concat()</span></code></a></li> 273<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.filter_keyvals"><code class="docutils literal notranslate"><span class="pre">filter_keyvals()</span></code></a></li> 274<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.filter_keyvals_regex"><code class="docutils literal notranslate"><span class="pre">filter_keyvals_regex()</span></code></a></li> 275<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.filter_peri
275od_intersect"><code class="docutils literal notranslate"><span class="pre">filter_period_intersect()</span></code></a></li> 276<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.flood"><code class="docutils literal notranslate"><span class="pre">flood()</span></code></a></li> 277<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.heartbeat_merge"><code class="docutils literal notranslate"><span class="pre">heartbeat_merge()</span></code></a></li> 278<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.heartbeat_reduce"><code class="docutils literal notranslate"><span class="pre">heartbeat_reduce()</span></code></a></li> 279<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.limit_events"><code class="docutils literal notranslate"><span class="pre">limit_events()</span></code></a></li> 280<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.merge_events_by_keys"><code class="docutils literal notranslate"><span class="pre">merge_events_by_keys()</span></code></a></li> 281<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.period_union"><code class="docutils literal notranslate"><span class="pre">period_union()</span></code></a></li> 282<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.simplify_string"><code class="docutils literal notranslate"><span class="pre">simplify_string()</span></code></a></li> 283<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.sort_by_duration"><code class="docutils literal notranslate"><span class="pre">sort_by_duration()</span></code></a></li> 284<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.sort_by_timestamp"><code class="docutils literal notranslate"><span class="pre">sort_by_timestamp()</span></code></a></li> 285<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.split_url_events"><code class="docutils literal notranslate"><span class="pre">split_url_events()</span></code></a></li> 286<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.sum_durations"><code class="docutils literal notranslate"><span class="pre">sum_durations()</span></code></a></li> 287<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.tag"><code class="docutils literal notranslate"><span class="pre">tag()</span></code></a></li> 288<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.union"><code class="docutils literal notranslate"><span class="pre">union()</span></code></a></li> 289<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_transform.union_no_overlap"><code class="docutils literal notranslate"><span class="pre">union_no_overlap()</span></code></a></li> 290</ul> 291</li> 292<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-query">aw_query</a><ul> 293<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.query"><code class="docutils literal notranslate"><span class="pre">query()</span></code></a></li> 294<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_categorize"><code class="docutils literal notranslate"><span class="pre">q2_categorize()</span></code></a></li> 295<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_chunk_events_by_key"><code class="docutils literal notranslate"><span class="pre">q2_chunk_events_by_key()</span></code></a></li> 296<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_concat"><code class="docutils literal notranslate"><span class="pre">q2_concat()</span></code></a></li> 297<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_exclude_keyvals"><code class="docutils literal notranslate"><span class="pre">q2_exclude_keyvals()</span></code></a></li> 298<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_filter_keyvals"><code class="docutils literal notranslate"><span class="pre">q2_filter_keyvals()</span></code></a></li> 299<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_filter_keyvals_regex"><code class="docutils literal notranslate"><span class="pre">q2_filter_keyvals_regex()</span></code></a></li> 300<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_filter_peri
300od_intersect"><code class="docutils literal notranslate"><span class="pre">q2_filter_period_intersect()</span></code></a></li> 301<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_find_bucket"><code class="docutils literal notranslate"><span class="pre">q2_find_bucket()</span></code></a></li> 302<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_flood"><code class="docutils literal notranslate"><span class="pre">q2_flood()</span></code></a></li> 303<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_limit_events"><code class="docutils literal notranslate"><span class="pre">q2_limit_events()</span></code></a></li> 304<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_merge_events_by_keys"><code class="docutils literal notranslate"><span class="pre">q2_merge_events_by_keys()</span></code></a></li> 305<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_nop"><code class="docutils literal notranslate"><span class="pre">q2_nop()</span></code></a></li> 306<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_period_union"><code class="docutils literal notranslate"><span class="pre">q2_period_union()</span></code></a></li> 307<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_query_bucket"><code class="docutils literal notranslate"><span class="pre">q2_query_bucket()</span></code></a></li> 308<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_query_bucket_eventcount"><code class="docutils literal notranslate"><span class="pre">q2_query_bucket_eventcount()</span></code></a></li> 309<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_simplify_window_titles"><code class="docutils literal notranslate"><span class="pre">q2_simplify_window_titles()</span></code></a></li> 310<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_sort_by_duration"><code class="docutils literal notranslate"><span class="pre">q2_sort_by_duration()</span></code></a></li> 311<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_sort_by_timestamp"><code class="docutils literal notranslate"><span class="pre">q2_sort_by_timestamp()</span></code></a></li> 312<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_split_url_events"><code class="docutils literal notranslate"><span class="pre">q2_split_url_events()</span></code></a></li> 313<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_sum_durations"><code class="docutils literal notranslate"><span class="pre">q2_sum_durations()</span></code></a></li> 314<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_tag"><code class="docutils literal notranslate"><span class="pre">q2_tag()</span></code></a></li> 315<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_query.functions.q2_union_no_overlap"><code class="docutils literal notranslate"><span class="pre">q2_union_no_overlap()</span></code></a></li> 316</ul> 317</li> 318<li class="toctree-l3"><a class="reference internal" href="api/python.html#module-aw_server">aw_server</a><ul> 319<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw_server.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li> 320<li class="toctree-l4"><a class="reference internal" href="api/python.html#aw-server-api">aw_server.api</a></li> 321</ul> 322</li> 323</ul> 324</li> 325<li class="toctree-l2"><a class="reference internal" href="api/rest.html">REST API</a><ul> 326<li class="toctree-l3"><a class="reference internal" href="api/rest.html#rest-security">REST Security</a></li> 327<li class="toctree-l3"><a class="reference internal" href="api/rest.html#rest-reference">REST Reference</a><ul> 328<li class="toctree-l4"><a class="reference internal" href="api/rest.html#buckets-api">Buckets API</a></li> 329<li class="toctree-l4"><a class="reference internal" href="api/rest.html#events-api">Events API</a></li> 330<li class="toctree-l4"><a class="reference internal" href="api/rest.html#heartbeat-api">Heartbeat API</a></li> 331<li class="toctree-l4"><a class="reference internal" href="api/rest.html#query-api">Query API</a></li> 332</ul> 333</li> 334</ul> 335</li> 336</ul> 337</li> 338<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a><ul> 339<li class="toctree-l2"><a class="reference internal" href="security.html#activitywatch-is-only-as-secure-as-your-system">ActivityWatch is only as secure as your system</a></li> 340<li class="toctree-l2"><a class="reference internal" href="security.html#deleting-sensitive-data">Deleting sensitive data</a></li> 341<li class="toctree-l2"><a class="reference internal" href="security.html#encrypting-data">Encrypting data</a></li> 342<li class="toctree-l2"><a class="reference internal" href="security.html#reproducible-builds">Reproducible builds</a></li> 343<li class="toctree-l2"><a class="reference internal" href="security.html#cors-configuration">CORS configuration</a></li> 344<li class="toctree-l2"><a class="reference internal" href="security.html#more">More?</a></li> 345</ul> 346</li> 347<li class="toctree-l1"><a class="reference internal" href="server-compare.html">Server comparison</a></li> 348<li class="toctree-l1"><a class="reference internal" href="development.html">Development Process</a><ul> 349<li class="toctree-l2"><a class="reference internal" href="development.html#working-with-submodules">Working with submodules</a></li> 350<li class="toctree-l2"><a class="reference internal" href="development.html#making-a-release">Making a release</a></li> 351</ul> 352</li> 353<li class="toctree-l1"><a class="reference internal" href="forking.html">Forking ActivityWatch</a><ul> 354<li class="toctree-l2"><a class="reference internal" href="forking.html#working-with-a-fork">Working with a fork</a><ul> 355<li class="toctree-l3"><a class="reference internal" href="forking.html#building-on-macos">Building on macOS</a></li> 356<li class="toctree-l3"><a class="reference internal" href="forking.html#updating-media-files">Updating media files</a></li> 357</ul> 358</li> 359<li class="toctree-l2"><a class="reference internal" href="forking.html#examples-of-forks">Examples of forks</a></li> 360</ul> 361</li> 362</ul> 363<p class="caption" role="heading"><span class="caption-text">Research</span></p> 364<ul> 365<li class="toctree-l1"><a class="reference internal" href="research/index.html">ActivityWatch in research</a><ul> 366<li class="toctree-l2"><a class="reference internal" href="research/index.html#why-researchers-use-it">Why researchers use it</a></li> 367<li class="toctree-l2"><a class="reference internal" href="research/index.html#how-to-cite">How to cite</a></li> 368<li class="toctree-l2"><a class="reference internal" href="research/index.html#studies-and-publications">Studies and publications</a><ul> 369<li class="toctree-l3"><a class="reference internal" href="research/index.html#used-as-a-data-collection-instrument">Used as a data-collection instrument</a></li> 370<li class="toctree-l3">
370<a class="reference internal" href="research/index.html#discussed-compared-or-built-upon">Discussed, compared or built upon</a></li> 371<li class="toctree-l3"><a class="reference internal" href="research/index.html#unpublished-or-unlisted-deployments">Unpublished or unlisted deployments</a><ul> 372<li class="toctree-l4"><a class="reference internal" href="research/participant-instructions.html">Participant instructions (Research Edition)</a></li> 373<li class="toctree-l4"><a class="reference internal" href="research/participant-instructions-android.html">Participant instructions â Android (Research Edition)</a></li> 374</ul> 375</li> 376</ul> 377</li> 378</ul> 379</li> 380</ul> 381<p class="caption" role="heading"><span class="caption-text">Meta</span></p> 382<ul> 383<li class="toctree-l1"><a class="reference internal" href="privacy.html">Privacy Policy</a><ul> 384<li class="toctree-l2"><a class="reference internal" href="privacy.html#introduction">Introduction</a></li> 385<li class="toctree-l2"><a class="reference internal" href="privacy.html#data-collected">Data Collected</a></li> 386<li class="toctree-l2"><a class="reference internal" href="privacy.html#analytics">Analytics</a></li> 387<li class="toctree-l2"><a class="reference internal" href="privacy.html#software-updates">Software Updates</a></li> 388<li class="toctree-l2"><a class="reference internal" href="privacy.html#data-protection">Data Protection</a></li> 389<li class="toctree-l2"><a class="reference internal" href="privacy.html#third-party-links">Third-party Links</a></li> 390</ul> 391</li> 392<li class="toctree-l1"><a class="reference internal" href="citing.html">How to cite ActivityWatch</a></li> 393<li class="toctree-l1"><a class="reference internal" href="history.html">History</a><ul> 394<li class="toctree-l2"><a class="reference internal" href="history.html#future">Future</a><ul> 395<li class="toctree-l3"><a class="reference internal" href="history.html#building-new-types-of-privacy-aware-services-which-require-data-collection">Building new types of privacy-aware services which require data collection</a></li> 396<li class="toctree-l3"><a class="reference internal" href="history.html#ubiquitous-recording-for-meaningful-information-about-the-past">Ubiquitous recording for meaningful information about the past</a></li> 397</ul> 398</li> 399</ul> 400</li> 401<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul> 402<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-11-0">v0.11.0</a><ul> 403<li class="toctree-l3"><a class="reference internal" href="changelog.html#summary">Summary</a></li> 404<li class="toctree-l3"><a class="reference internal" href="changelog.html#activitywatch-bundle-repo">activitywatch (bundle repo)</a></li> 405<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-webui">aw-webui</a><ul> 406<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-26">⨠Features (26)</a></li> 407</ul> 408</li> 409<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-client">aw-client</a><ul> 410<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-5">⨠Features (5)</a></li> 411</ul> 412</li> 413<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-core">aw-core</a><ul> 414<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-2">⨠Features (2)</a></li> 415</ul> 416</li> 417<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-qt">aw-qt</a><ul> 418<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-1">⨠Features (1)</a></li> 419</ul> 420</li> 421<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-server">aw-server</a><ul> 422<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-1-1">⨠Features (1)</a></li> 423</ul> 424</li> 425<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-server-rust">aw-server-rust</a><ul> 426<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-10">⨠Features (10)</a></li> 427</ul> 428</li> 429<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-watcher-afk">aw-watcher-afk</a><ul> 430<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-2-1">⨠Features (2)</a></li> 431</ul> 432</li> 433<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-watcher-window">aw-watcher-window</a><ul> 434<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-1-2">⨠Features (1)</a></li> 435</ul> 436</li> 437</ul> 438</li> 439<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-10-0">v0.10.0</a><ul> 440<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Summary</a></li> 441<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">activitywatch (bundle repo)</a><ul> 442<li class="toctree-l4"><a class="reference internal" href="changelog.html#id11">⨠Features (1)</a></li> 443</ul> 444</li> 445<li class="toctree-l3"><a class="reference internal" href="changelog.html#id13">aw-webui</a><ul> 446<li class="toctree-l4"><a class="reference internal" href="changelog.html#features-22">⨠Features (22)</a></li> 447</ul> 448</li> 449<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">aw-qt</a><ul> 450<li class="toctree-l4"><a class="reference internal" href="changelog.html#id16">⨠Features (1)</a></li> 451</ul> 452</li> 453<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">aw-server</a></li> 454<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">aw-server-rust</a></li> 455<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">aw-watcher-afk</a></li> 456<li class="toctree-l3"><a class="reference internal" href="changelog.html#id21">aw-watcher-window</a></li> 457<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">aw-client</a><ul> 458<li class="toctree-l4"><a class="reference internal" href="changelog.html#id23">⨠Features (2)</a></li> 459</ul> 460</li> 461<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">aw-core</a><ul> 462<li class="toctree-l4"><a class="reference internal" href="changelog.html#id26">⨠Features (1)</a></li> 463</ul> 464</li> 465<li class="toctree-l3"><a class="reference internal" href="changelog.html#media">media</a></li> 466</ul> 467</li> 468<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-9-0">v0.9.0</a></li> 469<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-4">v0.8.4</a></li> 470<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-3">v0.8.3</a></li> 471<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-2">v0.8.2</a></li> 472<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-1">v0.8.1</a></li> 473<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b9">v0.8.0b9</a></li> 474<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b8">v0.8.0b8</a></li> 475<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b7">v0.8.0b7</a></li> 476<li class="toctree-l2">
476<a class="reference internal" href="changelog.html#v0-8-0b2-v0-8-0b6">v0.8.0b2 - v0.8.0b6</a></li> 477<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b1">v0.8.0b1</a></li> 478<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-1">v0.7.1</a></li> 479<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b4">v0.7.0b4</a></li> 480<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b3">v0.7.0b3</a></li> 481<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b2">v0.7.0b2</a></li> 482<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b1">v0.7.0b1</a></li> 483<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-6-0-and-older">v0.6.0 and older</a></li> 484</ul> 485</li> 486</ul> 487 488 </div> 489 </div> 490 </nav> 491 492 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > 493 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 494 <a href="#">ActivityWatch</a> 495 </nav> 496 497 <div class="wy-nav-content"> 498 <div class="rst-content"> 499 <div role="navigation" aria-label="Page navigation"> 500 <ul class="wy-breadcrumbs"> 501 <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> 502 <li class="breadcrumb-item active">Welcome to the ActivityWatch documentation!</li> 503 <li class="wy-breadcrumbs-aside"> 504 <a href="https://github.com/ActivityWatch/docs/blob/master/src/index.rst" class="fa fa-github"> Edit on GitHub</a> 505 </li> 506 </ul> 507 <hr/> 508</div> 509 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 510 <div itemprop="articleBody"> 511 512 <img alt="_images/banner.png" src="_images/banner.png" /> 513<p align="center"> 514 515 <b> 516 <a href="https://activitywatch.net/">Website</a> 517 â <a href="https://forum.activitywatch.net/">Forum</a> 518 â <a href="https://docs.activitywatch.net/">Documentation</a>
519 â <a href="https://github.com/ActivityWatch/activitywatch/releases">Releases</a> 520 </b> 521 522 <br> 523 524 <b> 525 <a href="https://activitywatch.net/contributors/">Contributor stats</a> 526 â <a href="https://activitywatch.net/ci/">CI overview</a> 527 </b> 528 529 <br> 530 <br> 531 532 <a href="https://github.com/ActivityWatch/activitywatch/actions?query=branch%3Amaster"> 533 <img title="Build Status GitHub" src="https://github.com/ActivityWatch/activitywatch/workflows/Build/badge.svg?branch=master" /> 534 </a> 535 <a href="http://docs.activitywatch.net"> 536 <img title="Documentation" src="https://readthedocs.org/projects/activitywatch/badge/?version=latest" /> 537 </a> 538 539 <br> 540 541 <a href="https://github.com/ActivityWatch/activitywatch/releases"> 542 <img title="Latest release" src="https://img.shields.io/github/release-pre/ActivityWatch/activitywatch.svg"> 543 </a> 544 <a href="https://github.com/ActivityWatch/activitywatch/releases"> 545 <img title="Total downloads (GitHub Releases)" src="https://img.shields.io/github/downloads/ActivityWatch/
545activitywatch/total.svg" /> 546 </a> 547 <a href="https://discord.gg/vDskV9q"> 548 <img title="Discord" src="https://img.shields.io/discord/755040852727955476" /> 549 </a> 550 551 <br> 552 553 <a href="https://activitywatch.net/donate/"> 554 <img title="Donated" src="https://img.shields.io/badge/budget-%24201%2Fmo%20from%2040%20supporters-orange.svg" /> 555 </a> 556 <a href="https://doi.org/10.5281/zenodo.4957165"> 557 <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4957165.svg" /> 558 </a> 559 560 <br> 561 562 <a href="https://twitter.com/ActivityWatchIt"> 563 <img title="Twitter follow" src="https://img.shields.io/twitter/follow/ActivityWatchIt.svg?style=social&label=Follow"/> 564 </a> 565 <a href="https://github.com/ActivityWatch/activitywatch"> 566 <img title="Star on GitHub" src="https://img.shields.io/github/stars/ActivityWatch/activitywatch.svg?style=social&label=Star"> 567 </a> 568 569 <br> 570</p><section id="welcome-to-the-activitywatch-documentation"> 571<h1>Welcome to the ActivityWatch documentation!<a class="headerlink" href="#welcome-to-the-activitywatch-documentation" title="Link to this heading">¶</a></h1> 572<p>If you are new to ActivityWatch, check out the <a class="reference internal" href="getting-started.html#getting-started"><span class="std std-ref">Getting started guide</span></a>.</p> 573<section id="table-of-contents"> 574<h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">¶</a></h2> 575<div class="toctree-wrapper compound" id="user-docs"> 576<p class="caption" role="heading"><span class="caption-text">User documentation</span></p> 577<ul> 578<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul> 579<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-activitywatch">What is ActivityWatch?</a></li> 580<li class="toctree-l2"><a class="reference internal" href="introduction.html#reason-for-existence">Reason for existence</a></li> 581<li class="toctree-l2"><a class="reference internal" href="introduction.html#data-philosophy">Data philosophy</a></li> 582</ul> 583</li> 584<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul> 585<li class="toctree-l2"><a class="reference internal" href="getting-started.html#installation">Installation</a></li> 586<li class="toctree-l2"><a class="reference internal" href="getting-started.html#usage">Usage</a></li> 587<li class="toctree-l2"><a class="reference internal" href="getting-started.html#autostart">Autostart</a></li> 588</ul> 589</li> 590<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul> 591<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-server-python">aw-server-python</a></li> 592<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-server-rust">aw-server-rust</a></li> 593<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-client">aw-client</a></li> 594<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-watcher-afk">aw-watcher-afk</a></li> 595<li class="toctree-l2"><a class="reference internal" href="configuration.html#aw-watcher-window">aw-watcher-window</a></li> 596</ul> 597</li> 598<li class="toctree-l1"><a class="reference internal" href="directories.html">Directories</a><ul> 599<li class="toctree-l2"><a class="reference internal" href="directories.html#data">Data</a></li> 600<li class="toctree-l2"><a class="reference internal" href="directories.html#config">Config</a></li> 601<li class="toctree-l2"><a class="reference internal" href="directories.html#logs">Logs</a></li> 602<li class="toctree-l2"><a class="reference internal" href="directories.html#cache">Cache</a></li> 603</ul> 604</li> 605<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a><ul> 606<li class="toctree-l2"><a class="reference internal" href="features/user-interface.html">User Interface</a><ul> 607<li class="toctree-l3"><a class="reference internal" href="features/user-interface.html#web-interface">Web Interface</a></li> 608<li class="toctree-l3"><a class="reference internal" href="features/user-interface.html#tray-icon">Tray icon</a></li> 609</ul> 610</li> 611<li class="toctree-l2"><a class="reference internal" href="features/exporting-data.html">Exporting data</a></li> 612<li class="toctree-l2"><a class="reference internal" href="features/pausing-logging.html">Pausing logging</a></li> 613<li class="toctree-l2"><a class="reference internal" href="features/filtering-data.html">Filtering data</a></li> 614<li class="toctree-l2"><a class="reference internal" href="features/categorization.html">Categorization</a><ul> 615<li class="toctree-l3"><a class="reference internal" href="features/categorization.html#adding-and-editing-categories">Adding and editing categories</a></li> 616<li class="toctree-l3"><a class="reference internal" href="features/categorization.html#rules">Rules</a></li> 617</ul> 618</li> 619<li class="toctree-l2"><a class="reference internal" href="features/syncing.html">Syncing</a><ul> 620<li class="toctree-l3"><a class="reference internal" href="features/syncing.html#old-syncing-prototype">Old syncing prototype</a></li> 621</ul> 622</li> 623</ul> 624</li> 625<li class="toctree-l1"><a class="reference internal" href="watchers.html">Watchers</a><ul> 626<li class="toctree-l2"><a class="reference internal" href="watchers.html#window-watchers">Window watchers</a></li> 627<li class="toctree-l2"><a class="reference internal" href="watchers.html#browser-watchers">Browser watchers</a></li> 628<li class="toctree-l2"><a class="reference internal" href="watchers.html#editor-watchers">Editor watchers</a></li> 629<li class="toctree-l2"><a class="reference internal" href="watchers.html#media-watchers">Media watchers</a></li> 630<li class="toctree-l2"><a class="reference internal" href="watchers.html#other-watchers">Other watchers</a></li> 631<li class="toctree-l2"><a class="reference internal" href="watchers.html#importers">Importers</a></li> 632<li class="toctree-l2"><a class="reference internal" href="watchers.html#custom-visualizations">Custom visualizations</a></li> 633<li class="toctree-l2"><a class="reference internal" href="watchers.html#custom-watchers">Custom watchers</a></li> 634</ul> 635</li> 636<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul> 637<li class="toctree-l2"><a class="reference internal" href="faq.html#general">General</a><ul> 638<li class="toctree-l3"><a class="reference internal" href="faq.html#what-is-activitywatch">What is ActivityWatch?</a></li> 639<li class="toctree-l3"><a class="reference internal" href="faq.html#is-activitywatch-really-free">Is ActivityWatch really free?</a></li> 640<li class="toctree-l3"><a class="reference internal" href="faq.html#what-platforms-does-activitywatch-support">What platforms does ActivityWatch support?</a></li> 641<li class="toctree-l3"><a class="reference internal" href="faq.html#does-activitywatch-track-my-data-privately">Does ActivityWatch track my data privately?</a></li> 642<li class="toctree-l3"><a class="reference internal" href="faq.html#where-is-my-data-stored">Where is my data stored?</a></li> 643<li class="toctree-l3"><a class="reference internal" href="faq.html#how-does-activitywatch-compare-to-rescuetime">How does ActivityWatch compare to RescueTime?</a></li> 644<li class="toctree-l3"><a class="reference internal" href="faq.html#can-i-extend-activitywatch-with-custom-tracking">Can I extend ActivityWatch with custom tracking?</a></li> 645</ul> 646</li> 647<li class="toctree-l2"><a class="reference internal" href="faq.html#technical">Technical</a><ul> 648<li class="toctree-l3"><a class="reference internal" href="faq.html#how-do-i-interpret-the-raw-data">How do I interpret the raw data?</a></li> 649<li class="toctree-l3"><a class="reference internal" href="faq.html#how-can-i-use-activitywatch-with-my-own-code">How can I use ActivityWatch with my own code?</a></li> 650<li class="toctree-l3"><a class="reference internal" href="faq.html#how-does-activitywatch-know-when-i-am-afk">
650How does ActivityWatch know when I am AFK?</a></li> 651<li class="toctree-l3"><a class="reference internal" href="faq.html#can-i-change-when-activitywatch-marks-me-as-afk">Can I change when ActivityWatch marks me as AFK?</a></li> 652<li class="toctree-l3"><a class="reference internal" href="faq.html#why-is-the-active-window-logged-as-unknown-when-using-wayland">Why is the active window logged as âunknownâ when using Wayland?</a></li> 653<li class="toctree-l3"><a class="reference internal" href="faq.html#how-accurate-is-activitywatch">How accurate is ActivityWatch?</a></li> 654<li class="toctree-l3"><a class="reference internal" href="faq.html#what-happens-if-it-is-down-or-crashes">What happens if it is down or crashes?</a></li> 655<li class="toctree-l3"><a class="reference internal" href="faq.html#some-events-have-0-duration-what-does-this-mean">Some events have 0 duration. What does this mean?</a></li> 656</ul> 657</li> 658</ul> 659</li> 660<li class="toctree-l1"><a class="reference internal" href="syncing.html">Syncing</a><ul> 661<li class="toctree-l2"><a class="reference internal" href="syncing.html#android">Android</a></li> 662<li class="toctree-l2"><a class="reference internal" href="syncing.html#how-to-set-up-syncing">How to set up syncing</a></li> 663</ul> 664</li> 665<li class="toctree-l1"><a class="reference internal" href="migrating.html">Migrating</a><ul> 666<li class="toctree-l2"><a class="reference internal" href="migrating.html#migrating-to-aw-server-rust">Migrating to aw-server-rust</a><ul> 667<li class="toctree-l3"><a class="reference internal" href="migrating.html#using-aw-server-rust-by-default">Using aw-server-rust by default</a></li> 668<li class="toctree-l3"><a class="reference internal" href="migrating.html#importing-from-aw-server-python">Importing from aw-server-python</a></li> 669</ul> 670</li> 671<li class="toctree-l2"><a class="reference internal" href="migrating.html#database-schema-migrations">Database schema migrations</a></li> 672</ul> 673</li> 674<li class="toctree-l1"><a class="reference internal" href="running-on-gnome.html">Running on GNOME</a></li> 675<li class="toctree-l1"><a class="reference internal" href="remote-server.html">Remote server</a><ul> 676<li class="toctree-l2"><a class="reference internal" href="remote-server.html#but-then-how-do-i-get-all-my-data-in-one-place">But then how do I get all my data in one place?</a></li> 677<li class="toctree-l2"><a class="reference internal" href="remote-server.html#i-know-what-i-m-doing-how-can-i-set-it-up-anyway">I know what Iâm doing, how can I set it up anyway?</a><ul> 678<li class="toctree-l3"><a class="reference internal" href="remote-server.html#ssh-tunnel">SSH tunnel</a></li> 679<li class="toctree-l3"><a class="reference internal" href="remote-server.html#opening-the-server-to-the-network">Opening the server to the network</a></li> 680</ul> 681</li> 682<li class="toctree-l2"><a class="reference internal" href="remote-server.html#previous-discussions">Previous discussions</a></li> 683</ul> 684</li> 685<li class="toctree-l1"><a class="reference internal" href="updating.html">Updating</a><ul> 686<li class="toctree-l2"><a class="reference internal" href="updating.html#macos">macOS</a></li> 687</ul> 688</li> 689<li class="toctree-l1"><a class="reference internal" href="uninstalling.html">Uninstalling</a><ul> 690<li class="toctree-l2"><a class="reference internal" href="uninstalling.html#removing-data">Removing data</a></li> 691</ul> 692</li> 693</ul> 694</div> 695<div class="toctree-wrapper compound" id="dev-docs"> 696<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p> 697<ul> 698<li class="toctree-l1"><a class="reference internal" href="installing-from-source.html">Installing from source</a><ul> 699<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#cloning-the-repository-and-submodules">Cloning the repository and submodules</a></li> 700<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#checking-dependencies">Checking dependencies</a></li> 701<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#using-a-virtualenv">Using a virtualenv</a></li> 702<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#building-and-installing">Building and installing</a></li> 703<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#running">Running</a></li> 704<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#updating-from-source">Updating from source</a></li> 705<li class="toctree-l2"><a class="reference internal" href="installing-from-source.html#packaging-your-changes">Packaging your changes</a></li> 706</ul> 707</li> 708<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI Usage</a><ul> 709<li class="toctree-l2"><a class="reference internal" href="cli.html#aw-client">
709aw-client</a></li> 710<li class="toctree-l2"><a class="reference internal" href="cli.html#not-yet-documented">Not yet documented</a></li> 711</ul> 712</li> 713<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a><ul> 714<li class="toctree-l2"><a class="reference internal" href="architecture.html#dependency-graph">Dependency graph</a></li> 715<li class="toctree-l2"><a class="reference internal" href="architecture.html#server">Server</a></li> 716<li class="toctree-l2"><a class="reference internal" href="architecture.html#clients-watchers-importers-and-observers">Clients (watchers, importers, and observers)</a></li> 717<li class="toctree-l2"><a class="reference internal" href="architecture.html#user-interfaces">User interfaces</a></li> 718<li class="toctree-l2"><a class="reference internal" href="architecture.html#libraries">Libraries</a><ul> 719<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-core">aw-core</a></li> 720<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-client">aw-client</a></li> 721<li class="toctree-l3"><a class="reference internal" href="architecture.html#aw-analysis">aw-analysis</a></li> 722</ul> 723</li> 724</ul> 725</li> 726<li class="toctree-l1"><a class="reference internal" href="buckets-and-events.html">Data model</a><ul> 727<li class="toctree-l2"><a class="reference internal" href="buckets-and-events.html#buckets">Buckets</a></li> 728<li class="toctree-l2"><a class="reference internal" href="buckets-and-events.html#events">Events</a><ul> 729<li class="toctree-l3"><a class="reference internal" href="buckets-and-events.html#heartbeats">Heartbeats</a></li> 730<li class="toctree-l3"><a class="reference internal" href="buckets-and-events.html#event-types">Event types</a></li> 731</ul> 732</li> 733</ul> 734</li> 735<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul> 736<li class="toctree-l2"><a class="reference internal" href="examples.html#getting-your-data-out">Getting Your Data Out</a><ul> 737<li class="toctree-l3"><a class="reference internal" href="examples/working-with-data.html">Working with ActivityWatch Data</a></li> 738<li class="toctree-l3"><a class="reference internal" href="examples/agents-and-ai.html">ActivityWatch with agents and AI</a></li> 739</ul> 740</li> 741<li class="toctree-l2"><a class="reference internal" href="examples.html#writing-your-own-watchers">Writing Your Own Watchers</a><ul> 742<li class="toctree-l3"><a class="reference internal" href="examples/writing-watchers.html">Writing your first watcher in Python</a></li> 743<li class="toctree-l3"><a class="reference internal" href="examples/writing-watchers.html#writing-your-first-watcher-in-rust">Writing your first watcher in Rust</a></li> 744</ul> 745</li> 746<li class="toctree-l2"><a class="reference internal" href="examples.html#example-code-repository">Example Code Repository</a></li> 747</ul> 748</li> 749<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a><ul> 750<li class="toctree-l2"><a class="reference internal" href="api/python.html">API Reference (Python)</a><ul> 751<li class="toctree-l3"><a class="reference internal" href="api/python.html#module-aw_core">aw_core</a></li> 752<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-client">aw_client</a></li> 753<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-transform">aw_transform</a></li> 754<li class="toctree-l3"><a class="reference internal" href="api/python.html#aw-query">aw_query</a></li> 755<li class="toctree-l3"><a class="reference internal" href="api/python.html#module-aw_server">aw_server</a></li> 756</ul> 757</li> 758<li class="toctree-l2"><a class="reference internal" href="api/rest.html">REST API</a><ul> 759<li class="toctree-l3"><a class="reference internal" href="api/rest.html#rest-security">REST Security</a></li> 760<li class="toctree-l3"><a class="reference internal" href="api/rest.html#rest-reference">REST Reference</a></li> 761</ul> 762</li> 763</ul> 764</li> 765<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a><ul> 766<li class="toctree-l2"><a class="reference internal" href="security.html#activitywatch-is-only-as-secure-as-your-system">ActivityWatch is only as secure as your system</a></li> 767<li class="toctree-l2"><a class="reference internal" href="security.html#deleting-sensitive-data">Deleting sensitive data</a></li> 768<li class="toctree-l2"><a class="reference internal" href="security.html#encrypting-data">Encrypting data</a></li> 769<li class="toctree-l2"><a class="reference internal" href="security.html#reproducible-builds">Reproducible builds</a></li> 770<li class="toctree-l2"><a class="reference internal" href="security.html#cors-configuration">CORS configuration</a></li> 771<li class="toctree-l2"><a class="reference internal" href="security.html#more">More?</a></li> 772</ul> 773</li> 774<li class="toctree-l1"><a class="reference internal" href="server-compare.html">Server comparison</a></li> 775<li class="toctree-l1"><a class="reference internal" href="development.html">Development Process</a><ul> 776<li class="toctree-l2"><a class="reference internal" href="development.html#working-with-submodules">Working with submodules</a></li> 777<li class="toctree-l2"><a class="reference internal" href="development.html#making-a-release">Making a release</a></li> 778</ul> 779</li> 780<li class="toctree-l1"><a class="reference internal" href="forking.html">Forking ActivityWatch</a><ul> 781<li class="toctree-l2"><a class="reference internal" href="forking.html#working-with-a-fork">Working with a fork</a><ul> 782<li class="toctree-l3"><a class="reference internal" href="forking.html#building-on-macos">Building on macOS</a></li> 783<li class="toctree-l3"><a class="reference internal" href="forking.html#updating-media-files">Updating media files</a></li> 784</ul> 785</li> 786<li class="toctree-l2"><a class="reference internal" href="forking.html#examples-of-forks">Examples of forks</a></li> 787</ul> 788</li> 789</ul> 790</div> 791<div class="toctree-wrapper compound" id="research-docs"> 792<p class="caption" role="heading"><span class="caption-text">Research</span></p> 793<ul> 794<li class="toctree-l1"><a class="reference internal" href="research/index.html">ActivityWatch in research</a><ul> 795<li class="toctree-l2"><a class="reference internal" href="research/index.html#why-researchers-use-it">Why researchers use it</a></li> 796<li class="toctree-l2"><a class="reference internal" href="research/index.html#how-to-cite">How to cite</a></li> 797<li class="toctree-l2"><a class="reference internal" href="research/index.html#studies-and-publications">Studies and publications</a></li> 798</ul> 799</li> 800</ul> 801</div> 802<div class="toctree-wrapper compound" id="meta-docs"> 803<p class="caption" role="heading"><span class="caption-text">Meta</span></p> 804<ul> 805<li class="toctree-l1"><a class="reference internal" href="privacy.html">Privacy Policy</a><ul> 806<li class="toctree-l2"><a class="reference internal" href="privacy.html#introduction">Introduction</a></li> 807<li class="toctree-l2"><a class="reference internal" href="privacy.html#data-collected">Data Collected</a></li> 808<li class="toctree-l2"><a class="reference internal" href="privacy.html#analytics">Analytics</a></li> 809<li class="toctree-l2"><a class="reference internal" href="privacy.html#software-updates">Software Updates</a></li> 810<li class="toctree-l2">
810<a class="reference internal" href="privacy.html#data-protection">Data Protection</a></li> 811<li class="toctree-l2"><a class="reference internal" href="privacy.html#third-party-links">Third-party Links</a></li> 812</ul> 813</li> 814<li class="toctree-l1"><a class="reference internal" href="citing.html">How to cite ActivityWatch</a></li> 815<li class="toctree-l1"><a class="reference internal" href="history.html">History</a><ul> 816<li class="toctree-l2"><a class="reference internal" href="history.html#future">Future</a><ul> 817<li class="toctree-l3"><a class="reference internal" href="history.html#building-new-types-of-privacy-aware-services-which-require-data-collection">Building new types of privacy-aware services which require data collection</a></li> 818<li class="toctree-l3"><a class="reference internal" href="history.html#ubiquitous-recording-for-meaningful-information-about-the-past">Ubiquitous recording for meaningful information about the past</a></li> 819</ul> 820</li> 821</ul> 822</li> 823<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul> 824<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-11-0">v0.11.0</a><ul> 825<li class="toctree-l3"><a class="reference internal" href="changelog.html#summary">Summary</a></li> 826<li class="toctree-l3"><a class="reference internal" href="changelog.html#activitywatch-bundle-repo">activitywatch (bundle repo)</a></li> 827<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-webui">aw-webui</a></li> 828<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-client">aw-client</a></li> 829<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-core">aw-core</a></li> 830<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-qt">aw-qt</a></li> 831<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-server">aw-server</a></li> 832<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-server-rust">aw-server-rust</a></li> 833<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-watcher-afk">aw-watcher-afk</a></li> 834<li class="toctree-l3"><a class="reference internal" href="changelog.html#aw-watcher-window">aw-watcher-window</a></li> 835</ul> 836</li> 837<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-10-0">v0.10.0</a><ul> 838<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Summary</a></li> 839<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">activitywatch (bundle repo)</a></li> 840<li class="toctree-l3"><a class="reference internal" href="changelog.html#id13">aw-webui</a></li> 841<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">aw-qt</a></li> 842<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">aw-server</a></li> 843<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">aw-server-rust</a></li> 844<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">aw-watcher-afk</a></li> 845<li class="toctree-l3"><a class="reference internal" href="changelog.html#id21">aw-watcher-window</a></li> 846<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">aw-client</a></li> 847<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">aw-core</a></li> 848<li class="toctree-l3"><a class="reference internal" href="changelog.html#media">media</a></li> 849</ul> 850</li> 851<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-9-0">v0.9.0</a></li> 852<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-4">v0.8.4</a></li> 853<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-3">v0.8.3</a></li> 854<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-2">v0.8.2</a></li> 855<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-1">v0.8.1</a></li> 856<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b9">v0.8.0b9</a></li> 857<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b8">v0.8.0b8</a></li> 858<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b7">v0.8.0b7</a></li> 859<li class="toctree-l2">
859<a class="reference internal" href="changelog.html#v0-8-0b2-v0-8-0b6">v0.8.0b2 - v0.8.0b6</a></li> 860<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-8-0b1">v0.8.0b1</a></li> 861<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-1">v0.7.1</a></li> 862<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b4">v0.7.0b4</a></li> 863<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b3">v0.7.0b3</a></li> 864<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b2">v0.7.0b2</a></li> 865<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-7-0b1">v0.7.0b1</a></li> 866<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-6-0-and-older">v0.6.0 and older</a></li> 867</ul> 868</li> 869</ul> 870</div> 871</section> 872<section id="indices-and-tables"> 873<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2> 874<ul class="simple"> 875<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> 876<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> 877<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> 878</ul> 879</section> 880</section> 881 882 883 </div> 884 </div> 885 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> 886 <a href="introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> 887 </div> 888 889 <hr/> 890 891 <div role="contentinfo"> 892 <p>© Copyright 2016-2026 ActivityWatch core contributors.</p> 893 </div> 894 895 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a 896 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> 897 provided by <a href="https://readthedocs.org">Read the Docs</a>. 898 899 900</footer> 901 </div> 902 </div> 903 </section> 904 </div> 905
905<script> 906 jQuery(function () { 907 SphinxRtdTheme.Navigation.enable(true); 908 }); 909 </script>
909 910 911</body> 912</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.