https://github.com/wakatime/wakatime-mode
Emacs plugin for automatic time tracking and metrics generated from your programming activity.
https://github.com/wakatime/wakatime-mode
emacs time-tracking
Last synced: 27 days ago
JSON representation
Emacs plugin for automatic time tracking and metrics generated from your programming activity.
- Host: GitHub
- URL: https://github.com/wakatime/wakatime-mode
- Owner: wakatime
- Created: 2014-11-23T03:41:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T06:53:19.000Z (10 months ago)
- Last Synced: 2025-03-29T19:06:51.817Z (about 1 month ago)
- Topics: emacs, time-tracking
- Language: Emacs Lisp
- Homepage: https://wakatime.com/emacs
- Size: 77.1 KB
- Stars: 276
- Watchers: 14
- Forks: 43
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
Awesome Lists containing this project
README
# Emacs Minor Mode for WakaTime
`wakatime-mode` is an automatic time tracking extension for Emacs using [WakaTime](https://wakatime.com/).
## Installation
1. Install wakatime-mode for Emacs using [MELPA](https://melpa.org/#/wakatime-mode) (Doom users see [these instructions][doom install] instead).
2. Download [wakatime-cli](https://github.com/wakatime/wakatime-cli/releases) to `~/.wakatime/` or somewhere in your `$PATH`. (Or `brew install wakatime-cli` on Mac)
3. Add `(global-wakatime-mode)` to your `init.el` file, then restart Emacs.
4. You will see a prompt asking for the path to wakatime-cli. Run `which wakatime-cli` and enter that path into the emacs prompt, then press `enter`.
5. Enter your [api key](https://wakatime.com//api-key) in your `init.el` or `~/.wakatime.cfg` file ([config file format](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#ini-config-file)).
6. Use Emacs with wakatime-mode turned on and your time will be tracked for you automatically.
7. Visit http://wakatime.com to see your logged time.
### Installation for Spacemacs
See [Installing WakaTime with Spacemacs](https://develop.spacemacs.org/layers/+web-services/wakatime/README.html).
## Screen Shots
## 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](https://wakatime.com/api-key).
Point `wakatime-cli-path` to the absolute path of [wakatime-cli](https://github.com/wakatime/wakatime-cli/releases).
## 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](https://wakatime.com/api).
[doom install]: https://medium.com/@el.gamerph/how-to-install-wakatime-in-doom-emacs-e5c582e15261