wakatime-zsh-plugin

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

wakatime-zsh-plugin

★ 95 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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`

### Project Detection

The plugin determines the project name using the following priority:

1. `.wakatime-project` file in the current directory
2. `.wakatime-project` file at the git repository root
3. If inside a git repo but no `.wakatime-project` file is found, the `--project` flag is omitted so that `wakatime-cli` can auto-detect the project (e.g. from the git remote URL when [`project_from_git_remote`](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md) is enabled in `~/.wakatime.cfg`)
4. If not inside a git repository, the project name defaults to `Terminal`

## 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.

wakatime-zsh-plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README