https://github.com/ricardoraposo/kee

A pretty cool small CLI interval timer
https://github.com/ricardoraposo/kee

Last synced: about 1 month ago
JSON representation

A pretty cool small CLI interval timer

• Host: GitHub
• URL: https://github.com/ricardoraposo/kee
• Owner: ricardoraposo
• Created: 2023-08-04T01:40:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-05T10:50:38.000Z (over 1 year ago)
• Last Synced: 2023-08-05T11:41:54.297Z (over 1 year ago)
• Language: Shell
• Size: 131 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kee - a CLI interval timer

Kee is a small CLI timer, made to be integrated with other applications that allow running

terminal commands inside it. For example TMUX and vim.

![](./images/keegif.gif)

## Usage

```sh

kee start   # it starts the timer according to the default time

kee start 

kee start hour

kee set default 10m   # it sets the default timer to 10 minutes

kee stop

kee help

```

It can do more stuff, check 'kee help' for instructions.

It is possible to pass a time unit for ``.

Valid time units are "s", "m", "h".

If no unit is passed, than nothing is considered, the timer starts with 0.

## Install

```sh

curl -sSO https://raw.githubusercontent.com/ricardoraposo/kee/main/kee

chmod +x kee

sudo mv kee ~/.local/bin # you can move it to wherever you feel it's best for you, as long as it's on your PATH

```

## Tab Completion

To activate tab completion just use the `complete -C` option from your

`.bashrc` or command line.

It also works on zsh if you have Oh My Zsh installed.

```

complete -C kee kee

```

## Integration with TMUX

Here's an example of how to add `kee` to your TMUX configuration.

Add the lines below to your `.tmux.conf` file.

```tmux

set -g status-interval 1

set -g status-right "#(kee show)"

```

## Integration with vim/neovim

Here's an example of how to add `kee` to your TMUX configuration.

This didn't look good, I'm sure you can do better than me.

```vim

function! Kee()

  return system("kee show")

endfunction

set statusline+=%{Kee()}

```