Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sobolevn/wakatime-zsh-plugin

🕒Track how much time you have spent in your terminal!
https://github.com/sobolevn/wakatime-zsh-plugin

antigen oh-my-zsh oh-my-zsh-plugin shell time-tracking wakatime zsh zsh-plugin

Last synced: about 2 months ago
JSON representation

🕒Track how much time you have spent in your terminal!

Host: GitHub
URL: https://github.com/sobolevn/wakatime-zsh-plugin
Owner: sobolevn
License: mit
Created: 2018-01-28T15:33:18.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-02-12T16:47:38.000Z (7 months ago)
Last Synced: 2024-04-16T02:06:39.341Z (5 months ago)
Topics: antigen, oh-my-zsh, oh-my-zsh-plugin, shell, time-tracking, wakatime, zsh, zsh-plugin
Language: Shell
Homepage: https://wakatime.com/terminal
Size: 179 KB
Stars: 85
Watchers: 4
Forks: 12
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# wakatime-zsh-plugin

[![wemake.services](https://img.shields.io/badge/style-wemake.services-green.svg?label=&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](http://wemake.services) [![Build Status](https://img.shields.io/travis/sobolevn/wakatime-zsh-plugin/master.svg)](https://travis-ci.org/sobolevn/wakatime-zsh-plugin) [![GitHub Release](https://img.shields.io/badge/release-0.2.1-brightgreen.svg?style=default)](https://github.com/sobolevn/wakatime-zsh-plugin/releases)

## 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](https://github.com/sobolevn/wakatime-zsh-plugin/blob/master/info.png)

## Prerequisites

Before we start you will need to run:

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

This command will install [Wakatime's CLI](https://github.com/wakatime/wakatime-cli).

## Installation

### antigen

If you're using [`antigen`](https://github.com/zsh-users/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

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

Then set `wakatime` to [the plugins list](https://github.com/robbyrussell/oh-my-zsh/wiki/External-plugins) inside your `.zshrc`.

Official plugin [documentation](https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#adding-a-new-plugin)

## Configuration

Wakatime supports configuration via [`~/.wakatime.cfg`](https://github.com/wakatime/wakatime#configuring). 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`](https://github.com/wbingli/zsh-wakatime/blob/master/zsh-wakatime.plugin.zsh)
2. [`bash-wakatime`](https://github.com/gjsheep/bash-wakatime)
3. [`fish-wakatime`](https://github.com/Cyber-Duck/fish-wakatime)

See the full list [here](https://wakatime.com/terminal).

## License

MIT. See [LICENSE](https://github.com/sobolevn/wakatime-zsh-plugin/blob/master/LICENSE) for more details.