Welcome to the ActivityWatch documentation!

If you are new to ActivityWatch, check out the Getting started guide.

User documentation

• Introduction
  • What ActivityWatch is
  • Reason for existence
  • Data philosophy
• Getting started
  • Installation
  • Usage
  • Autostart
• Configuration
• Directories
  • Data
  • Config
  • Logs
  • Cache
• Features
  • User Interface
    • Web Interface
    • Tray icon
  • Exporting data
  • Pausing logging
  • Filtering data
  • Categorization
    • Adding and editing categories
    • Rules
  • Syncing
• Watchers
  • Browser watchers
  • Editor watchers
  • Media watchers
  • Other watchers
  • Custom watchers
• Importers
• FAQ
  • Where is my data stored?
  • How do I interpret the raw data?
  • How can I use ActivityWatch with my own code?
  • How does ActivityWatch know when I am AFK?
  • Why is the active window logged as “unknown” when using Wayland?
  • What happens if it is down or crashes?
  • Some events have 0 duration. What does this mean?
• History
  • Future
    • Building new types of privacy-aware services which require data collection
    • Ubiquitous recording for meaningful information about the past
• Migrating
  • Migrating to aw-server-rust
  • Database schema migrations
• Running on GNOME
• Remote server
  • But then how do I get all my data in one place?
  • I know what I’m doing, how can I set it up anyway?
  • Previous discussions
• Updating
  • macOS
• Uninstalling
  • Removing data

Developer documentation

• Installing from source
  • Cloning the repository and submodules
  • Checking dependencies
  • Using a virtualenv
  • Building and installing
  • Running
  • Updating from source
  • Packaging your changes
• Architecture
  • Dependency graph
  • Server
  • Clients (watchers, importers, and observers)
  • User interfaces
  • Libraries
    • aw-core
    • aw-client
    • aw-analysis
• Data model
  • Buckets
  • Events
    • Heartbeats
    • Event types
• Examples
  • Querying Data
    • Writing a Query
    • Fetching Raw Events
  • Writing your first watcher
    • Minimal client
    • Reference client
  • Extending ActivityWatch
    • Collecting more data
    • Fetching Data
• API Reference
  • API Reference (Python)
    • aw_core
    • aw_client
    • aw_transform
    • aw_query
    • aw_server
  • REST API
    • REST Security
    • REST Reference
• Security
  • ActivityWatch is only as secure as your system
  • Deleting sensitive data
  • Encrypting data
  • Reproducible builds
  • CORS configuration
  • More?
• Development Process
  • Working with submodules
  • Making a release
• Changelog
  • v0.9.0
  • v0.8.4
  • v0.8.3
  • v0.8.2
  • v0.8.1
  • v0.8.0b9
  • v0.8.0b8
  • v0.8.0b7
  • v0.8.0b2 - v0.8.0b6
  • v0.8.0b1
  • v0.7.1
  • v0.7.0b4
  • v0.7.0b3
  • v0.7.0b2
  • v0.7.0b1
  • v0.6.0 and older

Indices and tables

• Index

• Module Index

• Search Page