Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

wakatime-zsh-plugin

wemake.services Build Status GitHub Release

What does this plugin do?

This plugin provides zsh and wakatime integration. In other words, it tracks all time you spend in a terminal. Unlike other plugins, this one tries to keep all your spent time in the same wakatime's project.

Info

Prerequisites

Before we start you will need to run:

pip install 'wakatime>=12.0'

This command will install Wakatime's CLI.

Installation

antigen

If you're using antigen, you can install this plugin with antigen bundle sobolevn/wakatime-zsh-plugin.

zgen

If you're using zgen, add this plugin to your init.zsh with zgen load sobolevn/wakatime-zsh-plugin.

Manual

cd ~/.oh-my-zsh/custom/plugins && git clone https://github.com/sobolevn/wakatime-zsh-plugin.git wakatime

Then set wakatime to the plugins list inside your .zshrc.

Official plugin documentation

Configuration

Wakatime supports configuration via ~/.wakatime.cfg. You will need to set your api_key.

There are number of options to set via your environment variables:

  • $WAKATIME_DO_NOT_TRACK: you can also disable tracking for some period of time by setting WAKATIME_DO_NOT_TRACK=1. defaults to false
  • $WAKATIME_TIMEOUT: to limit the time to sync with the wakatime servers, defaults to 5 seconds
  • $WAKATIME_DISABLE_OFFLINE: to disable wakatime in offline mode, defaults to false

Alternatives

There are several alternatives to this project:

  1. zsh-wakatime
  2. bash-wakatime
  3. fish-wakatime

See the full list here.

License

MIT. See LICENSE for more details.