Skip to content

README.md

Latest commit

 

History

History
80 lines (56 loc) · 3.89 KB

README.md

File metadata and controls

80 lines (56 loc) · 3.89 KB

kate-wakatime

GitHub tag (with filter) License GitHub commits since latest release (by SemVer including pre-releases) CodeQL QA Tests Coverage Status pre-commit GitHub Pages Stargazers

@Tatsh Mastodon Follow

Kate plugin to interface with WakaTime.

Note

This is for Kate 6 (KTextEditor from KF 6).

If you need a version for Kate 5, use the v1.3.10 release.

If you need a version for Kate 4, use the v0.6 release.

Dependencies

How to install these on your distro is beyond the scope of this document. Generally, install the Kate text editor, CMake, KDE framework development packages, and Qt development packages.

How to use

wakatime-cli or wakatime must be in PATH or located in ~/.wakatime.

  1. Get an account at WakaTime.

  2. Get your API key.

  3. Clone this project and compile:

    git clone git@github.com:Tatsh/kate-wakatime.git
cd kate-wakatime
mkdir build
cd build

    Linux:

    cmake .. -DCMAKE_INSTALL_PREFIX=/usr

    MacPorts:

    cmake .. -DCMAKE_INSTALL_PREFIX=/opt/local/

    Finish the task:

    make
sudo make install

  4. Once this plugin is installed, open Kate and go to Settings, Configure Kate..., then in the dialog choose Plugins.

  5. Use the checkbox to enable WakaTime and click OK:

    screenshot

  6. Restart Kate to be sure the plugin initialises properly.

  7. Go to Settings, Configure WakaTime.... In the dialog, fill in your API key. Click OK to save.

To be certain this will work, check the file at ~/.wakatime.cfg.