Skip to content

README.md

Latest commit

 

History

History
44 lines (25 loc) · 2.19 KB

README.md

File metadata and controls

44 lines (25 loc) · 2.19 KB

Emacs Minor Mode for WakaTime

wakatime-mode is an automatic time tracking extension for Emacs using WakaTime.

Installation

  1. Configure wakatime-mode in your init.el file using use-package (this automatically installs it from MELPA):

    (use-package wakatime-mode
  :ensure t
  :config
  (global-wakatime-mode 1))

  2. Restart Emacs. wakatime-mode will automatically download the latest wakatime-cli into ~/.wakatime/ on first launch, and check for updates at most every 4 hours. To use a specific binary instead, set wakatime-cli-path to its absolute path (or install wakatime-cli into your $PATH, e.g. brew install wakatime-cli on macOS).

  3. Enter your api key in your init.el or ~/.wakatime.cfg file (config file format).

  4. Use Emacs with wakatime-mode turned on and your time will be tracked for you automatically.

  5. Visit http://wakatime.com to see your logged time.

Screen Shots

Project Overview

Usage

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

Configuration

Set variable wakatime-api-key to your API key.

By default wakatime-cli-path is nil, which tells wakatime-mode to look for an existing wakatime-cli on your $PATH and otherwise auto-download the latest wakatime-cli release into ~/.wakatime/. Set wakatime-cli-path to an absolute path to use a specific binary. Auto-update checks run at most every wakatime-update-check-interval seconds (4 hours by default).

Troubleshooting

To be sure heartbeats are getting sent, turn on debug mode by adding this line to your ~/.wakatime.cfg file:

debug = true

Then run tail -f ~/.wakatime/wakatime.log and make sure you see a 201 response code from the WakaTime API.