Skip to content

Latest commit

 

History

History
37 lines (18 loc) · 1.76 KB

README.md

File metadata and controls

37 lines (18 loc) · 1.76 KB
Raw

Emacs Minor Mode for ActivityWatch

MELPA

activity-watch-mode is an automatic time tracking extension for Emacs using ActivityWatch.

Installation

Heads Up! ActivityWatch depends on request.el being installed to work correctly.

It optionally depends on Projectile and Magit to detect project names.

  1. Install activity-watch-mode for Emacs using MELPA.

  2. Add (global-activity-watch-mode) to your init.el file, then restart Emacs.

  3. Use Emacs with activity-watch-mode turned on and your time will be tracked for you automatically.

  4. Visit http://localhost:5600 to see your logged time.

Usage

Enable ActivityWatch for the current buffer by invoking M-x activity-watch-mode. If you wish to activate it globally, run M-x global-activity-watch-mode.

Configuration

Set variable activity-watch-api-host to your activity watch local instance (default to http://localhost:5600).

By default, the extension will try to infer the name of the project by consulting Projectile and Magit. Users can add resolution methods by defining functions in the form activity-watch-project-name-<NAME> and then adding 'NAME to the list of resolvers activity-watch-project-name-resolvers. See its documentation for a list of predefined resolvers.

The default project name used when a proper one cannot be determined is "unknown" and can be customized via activity-watch-project-name-default.

Acknowledgments

This mode is based of the wakatime-mode.