/zsh-wakatime

ZSH plugin for wakatime

Primary LanguageShellMIT LicenseMIT

ZSH plugin for wakatime

Automatic time tracking for commands in ZSH using wakatime.

Installation

It depends on wakatime CLI 6.0 or higher. Make sure you have configured wakatime API key in your ~/.wakatime.cfg file. If you use wakatime in other editors, this file may be already there.

  1. python3 -c "$(wget -q -O - https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py)" to install wakatime CLI.

  2. For oh-my-zsh user:

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

  • Edit your .zshrc file and add zsh-wakatime to oh-my-zsh plugins

  1. For Antigen user:
  • antigen bundle wbingli/zsh-wakatime

  1. Open a new terminal and type commands

  2. Visit https://wakatime.com/project/Terminal

Project Detection

By default all actions logged by the ZSH plugin for wakatime are associated with the Terminal project, if you would like the plugin to attribute the project based on either git repository or the last accessed project then set ZSH_WAKATIME_PROJECT_DETECTION to true in your environment.

To enable:

  1. Edit your .zshrc
  2. Add the line export ZSH_WAKATIME_PROJECT_DETECTION=true at the top of the file.

Screenshot

waketime-zsh

Configuration

WakaTime plugins share a common config file .wakatime.cfg located in your user home directory with these options available.

Troubleshooting

If you don't see any data while visiting https://wakatime.com/project/Terminal, trying below to find out the problem:

  • Run ps | grep wakatime repeatedly as fast as possbile
  • You should notice process with command like wakatime --write --plugin zsh-wakatime/0.0.1 --entity-type app --project Terminal --entity ls
  • Copy that full command and execute in the terminal.
  • If any problem happens while running this command, please reference to https://github.com/wakatime/wakatime#troubleshooting for further troubleshootig.