Code Monkey home page Code Monkey logo

vscode-wakatime's Introduction

WakaTime for Visual Studio Code

Tests Version 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 $WAKATIME_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. $WAKATIME_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 $WAKATIME_HOME/.wakatime.log from wakatime-cli.

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.

Many thanks to all contributors!

Made with ❤️ by the WakaTime Team.

vscode-wakatime's People

Contributors

alanhamlett avatar codinggirl avatar gandarez avatar hardik127 avatar k33k0 avatar kidonng avatar mjbvz avatar notquiteamonad avatar psukys avatar salmonslay avatar valeth avatar zeh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.