Repository files navigation

WakaTime is an open source VS Code plugin for metrics, insights, and time tracking automatically generated from your programming activity.

1. PressF1 or⌘ + Shift + P and typeinstall. PickExtensions: Install Extension.

   

2. Typewakatime and hitenter.

   

3. Enter yourapi key, then pressenter.

   (If you’re not prompted, pressF1 or⌘ + Shift + P then typeWakaTime API Key.)

4. Use VSCode and your coding activity will be displayed on yourWakaTime dashboard

Visithttps://wakatime.com to see your coding activity.

VS Code specific settings are available from⌘ + Shift + P, then typingwakatime.

For example, to hide today's coding activity in your status bar:

Press⌘ + Shift + P then setWakaTime: Status Bar Coding Activity tofalse.

You can customize the position and priority of the WakaTime status bar item:

• Alignment: Setwakatime.align toleft orright to control which side of the status bar shows the WakaTime item
• Priority: Setwakatime.alignPriority to a number to control the order (higher values appear more to the left)

Both settings require restarting VS Code to take effect.

Extension settings are stored in the INI file at$HOME/.wakatime.cfg.

More information can be found fromwakatime-cli.

If using an online IDE likegitpods, add yourapi key to global ENV keyWAKATIME_API_KEY.

Notes:

1. $HOME defaults to$HOME
2. To disable the extension at startup adddisabled=true to your config, this operation can also be performed by pressing⌘ + Shift + P and selectingWakaTime: Disable.

First, turn on debug mode:

1. PressF1 or⌘ + Shift + P
2. Type> WakaTime: Debug, and pressEnter.
3. Selecttrue, then pressEnter.

Next, open your Developer Console to view logs and errors:

Help → Toggle Developer Tools

Errors outside the scope of vscode-wakatime go to$HOME/.wakatime/wakatime.log fromwakatime-cli.

If your error message contains "won't send heartbeat due to backoff" then delete your~/.wakatime/wakatime-internal.cfg file to trigger an API connection so we can see the real error message.

TheHow to Debug Plugins guide shows how to check when coding activity was last received from your editor using thePlugins Status Page.

Microsoft Windows Only: Using WakaTime behind a corporate proxy? Try enabling your Windows Root Certs inside VS Code with thewin-ca extension:PressCtrl + Shift + X, search forwin-ca, pressInstall.

For more general troubleshooting info, see thewakatime-cli Troubleshooting Section.

If you're connected to a remote host using thessh extension you might want to force WakaTime to run locally instead on the server. This configuration is needed when the server you connect is shared among other people. Please followthis guide.

1. Click the Extensions sidebar item in VS Code.

2. Typewakatime and hit enter.

3. Click the settings icon next to WakaTime, then click Uninstall.

4. Delete the~/.wakatime* files in your home directory, unless you’re still using WakaTime with another IDE.

Pull requests, bug reports, and feature requests are welcome!Please searchexisting issues before creating a new one.

To run from source:

1. git clone git@github.com:wakatime/vscode-wakatime.git
2. cd vscode-wakatime
3. npm install
4. npm run watch
5. Install the extension from the marketplace
6. Then symlink~/.vscode/extensions/wakatime.vscode-wakatime-*/dist/extension.js to./dist/extension.js

Or to run the web version from source:

1. git clone git@github.com:wakatime/vscode-wakatime.git
2. cd vscode-wakatime
3. npm install
4. npm run compile
5. npm run open-in-browser
6. Go tolocalhost:3000 in your web browser

Many thanks to allcontributors!

Made with ❤️ by theWakaTime Team.