Frequently Asked Questions

WakaTime only logs time when you're using your text editor by "pinging" the api with heartbeat events. You set a timeout value (default 15 minutes) and when you're not using your text editor for longer than your timeout value, that time doesn't get logged.

For example, if you took a 10 minute break and your timeout is set to the default 15 minutes, the 10 minutes where you were AFK will be logged. However, setting your timeout to 5 minutes would not log your 10 minute break.

WakaTime can accurately reflect the time you were coding in each file down to the second.

This high-level state machine shows how:

  1. WakaTime starts a timer when you begin editing a file.
  2. The timer is stopped when you go AFK by reaching your timeout setting. When you go AFK, WakaTime rewinds the timer until the time you last edited the file.
  3. The timer is also stopped when you switch to editing a different file. In this case, WakaTime saves the time from when you started editing the original file until when you switched to the new file. The time is reset and we start over at step 1 with the new file.

Your public profile uses the default 15 minute timeout value with a time range of Last 7 Days from Yesterday.

We also subtract coding activity from language Other.

The leaderboards use the same formula as your public profile.

Setting your preferences to the defaults, matching the leaderboard time range, and subtracting coding activity categorized as language Other will show the same coding activity as your dashboard.

Yes, when working offline your logged time is saved in an sqlite3 database at $HOME/.wakatime.db. The next time you use WakaTime with internet access, your logged time is syncronized to the api.

WakaTime logs heartbeat events triggered from user actions inside your text editor.

Heartbeat events contain data such as:

  • absolute path of current file [1]
  • current time as a UNIX epoch float (seconds.milliseconds)
  • whether the event was triggered from writing to a file
  • current project from a supported revision control
  • current branch from a supported revision control
  • total number of lines from the file as an integer
  • current cursor position as an integer
  • syntax language guessed from the file, for example Python or JavaScript
  • libraries and frameworks detected from the file, for example Flask or Rails

Heartbeat events are logged:

  • every 2 minutes if you are actively using your text editor
  • when you switch between files
  • every time you write to a file

The easiest way to hide files/folders from WakaTime is adding them to the exclude array in your $HOME/.wakatime.cfg file.

For example, to prevent tracking all folders named private:

[settings] exclude = /private/

For Windows use escaped backslashes:

[settings] exclude = \\private\\

You can list multiple paths in your config file, and each path is a POSIX regular expression:

[settings] exclude = ^/var /private_\d+/

The above example excludes any path starting with /var and also any folder named private_123 where 123 can be any number.

You can also configure WakaTime to obfuscate file names by adding hidefilenames = true to your $HOME/.wakatime.cfg file.

This means only your project names will be sent to the website, so you can not see logged time per file.

Note: Sublime Text users won't have a $HOME/.wakatime.cfg file, so create one using this example config.

Yes, you can export all your logged time in JSON format here.

Yes, all WakaTime plugins play well together. You can switch between multiple supported editors and your time will be logged correctly. If you use revision control software, your time will be logged to the correct project even when using multiple editors.

WakaTime recognizes the project's name one of four ways:

  1. Revision control software (Ex: Git, Mercurial, or Subversion):

    To set the project name for a folder, go to that folder in a terminal and type:

    git init

    Files inside that folder will be logged under a project with that folder's name.

  2. Create a .wakatime-project file inside your project directory. Type the project name as the first line of this file and WakaTime will use that project name for all files inside this directory.

  3. Adding the project directory to your ~/.wakatime.cfg file under the [projectmap] section.

  4. As a last resort use custom rules:

To exclude projects from being logged in the future, add the project's path to your ~/.wakatime.cfg file under the exclude setting.

To delete a project, you must first remove it's coding activity using the Coding Activity Delete Tool.

After you have removed all coding activity from a project, you can delete the project from the project's dashboard.

Read the Troubleshooting Guide.

To check for error messages:

  1. Open $HOME/.wakatime.log. Latest errors are at the bottom of that file.

  2. For Sublime, also check the Sublime Console by pressing ctrl+`.

  3. For Jetbrains IDEs, also check the idea.log file from Help -> Show Log.

Post any stack traces as an issue in the appropriate GitHub repo.

To generate a new api key on the website, go to your API Key page.

Make sure to update your api key in $HOME/.wakatime.cfg(for plugins using wakatime cli) or WakaTime.sublime-settings(for Sublime Text) with your newly generated api key.