sublime-wakatime/README.md

# sublime-wakatime

[![Coding time tracker](https://wakatime.com/badge/github/wakatime/sublime-wakatime.svg)](https://wakatime.com/badge/github/wakatime/sublime-wakatime)

[WakaTime][wakatime] is an open source Sublime Text plugin for metrics, insights, and time tracking automatically generated from your programming activity.


## Installation

1. Install [Package Control](https://packagecontrol.io/installation).

2. In Sublime, press `ctrl+shift+p`(Windows, Linux) or `cmd+shift+p`(OS X).

3. Type `install`, then press `enter` with `Package Control: Install Package` selected.

4. Type `wakatime`, then press `enter` with the `WakaTime` plugin selected.

5. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.

6. Use Sublime and your coding activity will be displayed on your [WakaTime dashboard](https://wakatime.com).


## Screen Shots

![Project Overview](https://wakatime.com/static/img/ScreenShots/Screen-Shot-2016-03-21.png)


## Unresponsive Plugin Warning

In Sublime Text 2, if you get a warning message:

    A plugin (WakaTime) may be making Sublime Text unresponsive by taking too long (0.017332s) in its on_modified callback.

To fix this, go to `Preferences → Settings - User` then add the following setting:

`"detect_slow_plugins": false`


## Troubleshooting

First, turn on debug mode in your `WakaTime.sublime-settings` file.

![sublime user settings](https://wakatime.com/static/img/ScreenShots/sublime-wakatime-settings-menu.png?v=3)

Add the line: `"debug": true`

Then, open your Sublime Console with `View → Show Console` ( CTRL + \` ) to see the plugin executing the wakatime cli process when sending a heartbeat.
Also, tail your `$HOME/.wakatime.log` file to debug wakatime cli problems.

The [How to Debug Plugins][how to debug] guide shows how to check when coding activity was last received from your editor using the [User Agents API][user agents api].
For more general troubleshooting info, see the [wakatime-cli Troubleshooting Section][wakatime-cli-help].

[wakatime]: https://wakatime.com/sublime-text
[wakatime-cli-help]: https://github.com/wakatime/wakatime#troubleshooting
[how to debug]: https://wakatime.com/faq#debug-plugins
[user agents api]: https://wakatime.com/developers#user_agents
fix badge locations 2019-11-28 09:28:20 +03:00			`# sublime-wakatime`
add wakatime badge 2019-11-26 08:30:54 +03:00
fix badge locations 2019-11-28 09:28:20 +03:00			`[![Coding time tracker](https://wakatime.com/badge/github/wakatime/sublime-wakatime.svg)](https://wakatime.com/badge/github/wakatime/sublime-wakatime)`
Initial commit 2013-07-02 09:43:12 +04:00
add sublime text to subtitle 2020-12-29 05:54:07 +03:00			`[WakaTime][wakatime] is an open source Sublime Text plugin for metrics, insights, and time tracking automatically generated from your programming activity.`
update plugin description 2016-01-04 04:47:56 +03:00
Partially revert "Use wakatime-cli standalone" to support both standalone and Python source wakatime-cli versions. This partially reverts commit d588451468fe6247a4873959b234ed0e49115f05. 2020-12-29 05:42:00 +03:00
fix badge locations 2019-11-28 09:28:20 +03:00			`## Installation`
initial commit 2013-07-02 13:21:13 +04:00
update name of Package Control 2015-01-07 01:07:55 +03:00			`1. Install [Package Control](https://packagecontrol.io/installation).`
initial commit 2013-07-02 13:21:13 +04:00
remove sub-list install instructions 2017-04-11 05:03:05 +03:00			2. In Sublime, press `ctrl+shift+p`(Windows, Linux) or `cmd+shift+p`(OS X).
initial commit 2013-07-02 13:21:13 +04:00
remove sub-list install instructions 2017-04-11 05:03:05 +03:00			3. Type `install`, then press `enter` with `Package Control: Install Package` selected.
initial commit 2013-07-02 13:21:13 +04:00
remove sub-list install instructions 2017-04-11 05:03:05 +03:00			4. Type `wakatime`, then press `enter` with the `WakaTime` plugin selected.
prompting user for api key if does not exist. updated readme with install instructions using Sublime Package Control. 2013-07-11 06:01:06 +04:00
remove sub-list install instructions 2017-04-11 05:03:05 +03:00			5. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.
formatted readme 2013-07-11 06:04:46 +04:00
remove sub-list install instructions 2017-04-11 05:03:05 +03:00			`6. Use Sublime and your coding activity will be displayed on your [WakaTime dashboard](https://wakatime.com).`
added install instructions for BIND9 2013-07-11 07:53:28 +04:00
Partially revert "Use wakatime-cli standalone" to support both standalone and Python source wakatime-cli versions. This partially reverts commit d588451468fe6247a4873959b234ed0e49115f05. 2020-12-29 05:42:00 +03:00
fix badge locations 2019-11-28 09:28:20 +03:00			`## Screen Shots`
initial commit 2013-07-02 13:21:13 +04:00
update screenshot 2016-03-21 03:46:22 +03:00			`![Project Overview](https://wakatime.com/static/img/ScreenShots/Screen-Shot-2016-03-21.png)`
initial commit 2013-07-02 13:21:13 +04:00
Partially revert "Use wakatime-cli standalone" to support both standalone and Python source wakatime-cli versions. This partially reverts commit d588451468fe6247a4873959b234ed0e49115f05. 2020-12-29 05:42:00 +03:00
fix badge locations 2019-11-28 09:28:20 +03:00			`## Unresponsive Plugin Warning`
add unresponsive plugin fix 2016-02-09 18:39:50 +03:00
			`In Sublime Text 2, if you get a warning message:`

			`A plugin (WakaTime) may be making Sublime Text unresponsive by taking too long (0.017332s) in its on_modified callback.`

use unicode arrow 2017-05-03 05:24:54 +03:00			To fix this, go to `Preferences → Settings - User` then add the following setting:
add unresponsive plugin fix 2016-02-09 18:39:50 +03:00
			`"detect_slow_plugins": false`

Partially revert "Use wakatime-cli standalone" to support both standalone and Python source wakatime-cli versions. This partially reverts commit d588451468fe6247a4873959b234ed0e49115f05. 2020-12-29 05:42:00 +03:00
fix badge locations 2019-11-28 09:28:20 +03:00			`## Troubleshooting`
troubleshooting section in readme 2015-07-15 23:44:07 +03:00
			First, turn on debug mode in your `WakaTime.sublime-settings` file.

update settings screenshot 2016-05-21 16:56:16 +03:00			`![sublime user settings](https://wakatime.com/static/img/ScreenShots/sublime-wakatime-settings-menu.png?v=3)`
troubleshooting section in readme 2015-07-15 23:44:07 +03:00
			Add the line: `"debug": true`

use unicode arrow 2017-04-15 20:13:42 +03:00			Then, open your Sublime Console with `View → Show Console` ( CTRL + \` ) to see the plugin executing the wakatime cli process when sending a heartbeat.
keyboard shortcut for opening console window 2017-02-27 07:08:15 +03:00			Also, tail your `$HOME/.wakatime.log` file to debug wakatime cli problems.
troubleshooting section in readme 2015-07-15 23:44:07 +03:00
link to FAQ from troubleshooting section 2017-05-26 17:40:14 +03:00			`The [How to Debug Plugins][how to debug] guide shows how to check when coding activity was last received from your editor using the [User Agents API][user agents api].`
			`For more general troubleshooting info, see the [wakatime-cli Troubleshooting Section][wakatime-cli-help].`

link directly to wakatime install instructions 2020-12-29 04:44:00 +03:00			`[wakatime]: https://wakatime.com/sublime-text`
link to FAQ from troubleshooting section 2017-05-26 17:40:14 +03:00			`[wakatime-cli-help]: https://github.com/wakatime/wakatime#troubleshooting`
			`[how to debug]: https://wakatime.com/faq#debug-plugins`
			`[user agents api]: https://wakatime.com/developers#user_agents`