Skip to content

Latest commit

 

History

History
122 lines (74 loc) · 5.22 KB

README.md

File metadata and controls

122 lines (74 loc) · 5.22 KB
Raw

WakaTime for Visual Studio Code

Version Installs WakaTime

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

Installation

  1. Press F1 or ⌘ + Shift + P and type install. Pick Extensions: Install Extension.

    type install

  2. Type wakatime and hit enter.

    type wakatime

  3. Enter your api key, then press enter.

    (If you’re not prompted, press F1 or ⌘ + Shift + P then type WakaTime API Key.)

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

Usage

Visit https://wakatime.com to see your coding activity.

Project Overview

Configuring

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

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

Press ⌘ + Shift + P then set WakaTime: Status Bar Coding Activity to false.

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

More information can be found from wakatime-cli.

If using an online IDE like gitpods, add your api key to global ENV key WAKATIME_API_KEY.

Notes:

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

Troubleshooting

First, turn on debug mode:

  1. Press F1 or ⌘ + Shift + P
  2. Type > WakaTime: Debug, and press Enter.
  3. Select true, then press Enter.

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 from wakatime-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.

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

Microsoft Windows Only: Using WakaTime behind a corporate proxy? Try enabling your Windows Root Certs inside VS Code with the win-ca extension: Press Ctrl + Shift + X, search for win-ca, press Install.

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

SSH configuration

If you're connected to a remote host using the ssh 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 follow this guide.

Uninstalling

  1. Click the Extensions sidebar item in VS Code.

  2. Type wakatime 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.

Contributing

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

To run from source:

  1. git clone [email protected]: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 [email protected]:wakatime/vscode-wakatime.git
  2. cd vscode-wakatime
  3. npm install
  4. npm run compile
  5. npm run open-in-browser
  6. Go to localhost:3000 in your web browser

Many thanks to all contributors!

Made with ❤️ by the WakaTime Team.