GitXplorerGitXplorer
s

wakatime-zsh-plugin

public
91 stars
10 forks
6 issues

Commits

List of commits on branch master.
Verified
7b3103d28c89f571111de3586c6ea98f5b26dd70

Delete .github/FUNDING.yml

ssobolevn committed 7 months ago
Verified
69c6028b0c8f72e2afcfa5135b1af29afb49764a

Update wakatime.plugin.zsh (#21)

mmodem7 committed 2 years ago
Verified
8b45c90d17674b107888aad9b94f7a0d95dd898b

Use new Go wakatime-cli (#19)

aalanhamlett committed 2 years ago
Verified
2ced689a3d2d72cc3311968340c4a743367fd086

Fixed Issue With The Plugin Not Finding The Wakatime Executable (#17)

hh4ckitt committed 3 years ago
Verified
1a846a24770ca4ec6eee0e59bba4c6395d1f448e

Support wakatime-cli custom path (#15)

eenricodeleo committed 3 years ago
Verified
d3f24e9b3c4eeff864d7508e2c11b74c6498c957

If it exists, get the project name from the `.wakatime-project` file (#13)

ssquatto committed 3 years ago

README

The README file for this repository.

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:

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

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
  • $ZSH_WAKATIME_BIN: set a custom path for the wakatime cli, defaults to wakatime

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.