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

https://github.com/0xjuanma/helm

A minimalistic and customizable pomodoro-like timer for your terminal written in Go. Includes default pomodoro timer and lets users define their own.
https://github.com/0xjuanma/helm

bubbletea charmbracelet cli command-line-tool go golang interactive minimalist pomodoro pomodoro-technique pomodoro-timer terminal-time-tracker tui

Last synced: about 2 months ago
JSON representation

A minimalistic and customizable pomodoro-like timer for your terminal written in Go. Includes default pomodoro timer and lets users define their own.

Awesome Lists containing this project

README

          


Helm Logo

Helm


[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Go Report Card](https://goreportcard.com/badge/github.com/0xjuanma/helm)](https://goreportcard.com/report/github.com/0xjuanma/helm)
[![GitHub Release](https://img.shields.io/github/v/release/0xjuanma/helm)](https://github.com/0xjuanma/helm/releases/latest)
[![Build Status](https://img.shields.io/github/actions/workflow/status/0xjuanma/helm/build.yml)](https://github.com/0xjuanma/helm/actions/workflows/build.yml)

A minimalistic TUI Pomodoro-like timer designed for pure focus. Protect your focus and time. Customize timers, switch between modes, and control everything with simple keyboard shortcuts; right from your terminal.

Helm Demo

## Installation/Update

### Homebrew

```bash
brew install 0xjuanma/tap/helm
```

### Script

```bash
curl -sSL https://raw.githubusercontent.com/0xjuanma/helm/main/scripts/install.sh | sh
```

### Build from Source

```bash
git clone https://github.com/0xjuanma/helm.git
cd helm
go build
./helm
```

## Usage

Start the Helm TUI by running `helm` in your terminal. From there, you can start, create and customize your own timer workflows to match your needs.

### Controls

| Key | Action |
|-----|--------|
| `j/k` or / arrows | Navigate |
| `enter` | Select |
| `space` | Start/Pause |
| `r` | Reset |
| `n` | Skip to next step |
| `c` | Customize workflows |
| `esc` | Back |
| `q` | Quit |

### Workflows

- **Pomodoro** - Classic 25/5 minute work/break cycle
- **Design Interview** - Structured interview practice (customizable)
- **Custom** - Create your own workflow

### Sound

- Toggle alerts on/off and switch between the terminal bell or the default macOS system sound from the workflow editor (`c` → pick a workflow, then adjust the sound lines).

Settings are stored in `~/.helm/settings.json`. Press `c` to customize workflows (sound settings live inside each editor).

**Author:** [@0xjuanma](https://github.com/0xjuanma)