tymr

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 48)

Stateful, general purpose timer/alarm CLI for Linux

tymr Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tymr
A stateful, general purpose timer/alarm CLI for Linux. It runs in the background, survives reboots, and understands human time.

https://github.com/user-attachments/assets/092a40f8-1155-435b-90e2-8d7634168250

## Features

- **Fire-and-forget:** Timers run in the background by default. No need to keep a terminal open.
- **Smart Time Parsing:** Understands `5m`, `2h30m`, `17:30`, `8:00pm`, `+2 days 14:00`, and more (anything `date` understands).
- **Stateful:** Timers/Alarms are tracked. `tymr` provides commands to list, cancel, or revive them (from a reboot).
- **Stopwatch Mode:** `tymr -s` counts up until you `Ctrl+C`.
- **Notifications:** Uses `notify-send` to send permanent notifications when a timer is up.
- **Sound Alarm:** Plays a looping sound until the notification is dismissed.
- **Configurable:** Set your own sound files, default volume, or even custom player commands in `~/.config/tymr/config`.
- **Remote Notications:** Optionally send a push notification to your phone(or any other device) via [ntfy.sh](https://ntfy.sh)

## Installation
This is a Bash script, so installation is simple:
```bash
git clone https://github.com/sahaj-b/tymr
cd tymr
sudo mv tymr /usr/local/bin/tymr
```

### Auto-Revive on Reboot
Timers survive reboots, but their processes are killed. Use `--revive` flag to:  
- Revive/Start the processes
- Notify for expired timers (when the system was off)

Autostart `tymr --revive` via your DE/WMs autostart settings. Eg, for hyprland, `exec-once = tymr --revive` in `~/.config/hyprland/hyprland.conf`.

##  Dependencies
- `date` (GNU coreutils version, usually pre-installed on Linux)
- `notify-send` (from `libnotify` or similar)

### Optional stuff
- `curl` (for `ntfy.sh` integration)
- `fzf`: for interactive timer deletion
- `paplay` / `ffplay` / `mpv`: for sound alarms. `tymr` auto-detects them.

##  Usage

```
USAGE:
  timer [OPTIONS] TIME/DURATION [TIMER_NAME]

OPTIONS:
  -s, --stopwatch                  Run as stopwatch (counts up)
  -f, --foreground                 Run timer in foreground
  -n, --no-sound                   Disable alarm sound
  -S, --sound-file PATH            Custom sound file to loop
  -v, --volume VOL                 Set volume (1-100)
  -t, --timeout MILISEC            Set notification/sound timeout in milliseconds(0=infinite)
  -h, --help                       Show this help message

TIMER MANAGEMENT:
  -l, --list                       List active timers
  -d, --delete [PID/NAME]          Delete timer. Runs in interactive mode(fzf) if no arg
  -r, --revive                     Revive killed timers' processes

NTFY OPTIONS:
  -N, --ntfy [TOPIC]               Send a fallback push via ntfy.sh/TOPIC
  -P, --ntfy-priority PRIORITY     Priority of the message (1=min, 2=low, 3=default, 4=high, 5=max)
  -U, --ntfy-url URL               Custom ntfy.sh URL (default: https://ntfy.sh)
  -A, --ntfy-auth CREDENTIALS      Authentication for custom ntfy instance (user:pass or Bearer token)

TIME/DURATION FORMATS:
  Plain seconds:    300, 1500, etc.
  Duration format:  5m, 2h30m, 1d12h, etc.
  Date/time format: '10:30', '10:30am', 'next Friday 14:00', '+2 days 5:00pm', etc.
  See 'date --help' for more information on valid date/time formats.
```

### Stopwatch
```bash
tymr -s
```

### Starting Timers
```bash
# Start a 25-minute timer named "Pomodoro" (runs in background)
tymr 25m "Pomodoro"

# Start a timer for 2 hours, 6 minutes, and 9 seconds
tymr 2h6m9s

# Watch the timer in the foreground (useful for debugging)
tymr -f 5s "Foreground test"

# Pomodoro
while true; do
  tymr -f 25m "Break"
  tymr -f 5m "Work"
done
```

### Setting Alarms
```bash
# Set an alarm for 17:30 today
tymr 17:30 "Evening Alarm"

# Set an alarm for 8:00pm tomorrow
tymr 'Tomorrow 8:00pm' "Attend meeting"

# Use any time formats that `date` understands
# you can check by running `date -d 'your time string'`
tymr 'next Friday 14:00' "Friday standup"
tymr '+2 days 5:00pm' "Review deadline"
tymr 'December 25 00:00' "Christmas"

# Mix with custom options
tymr -v 75 18:30 "Volume 75%, alarm at 18:30" # 75% volume
tymr -n 25m "Silent focus mode" # No sound
tymr -S /path/to/myAlarm.wav 10m "Custom sound alarm" # Custom sound file
tymr 45m "check oven" -t 5000  # Auto-dismiss notification/sound after 5 seconds
```

### Managing Timers
```bash
# List all active timers with time remaining
tymr -l

# Delete a specific timer by name or PID
tymr -d "Pomodoro"
tymr -d 12345

# Delete a timer interactively (fuzzy search + select)
tymr -d
```

### Fallback push notifications via ntfy.sh
- [ntfy.sh](https://ntfy.sh) is a notification service that can send push notifications to your devices
- Install the app on your phone(or other devices) and subscribe to a topic
- Use `-N TOPIC`(or specify in config) to send a push notification to that topic when the timer is up.
```bash
tymr -N my-phone-tymr-notif 10m "Meeting in 10 minutes"
```
-  See [Usage](#usage) or `-h` for more ntfy options.

> [!NOTE]
> Even if you have a default topic set in the config file, `-N` (as the last argument) is required to send ntfy notifs.  
> eg: `tymr 10m hi -N`

> [!WARNING]
> Once the timer is up, the ntfy push notification can't be dismissed, even if you delete the timer using `tymr -d`

### Configuration File
Create `~/.config/tymr/config` to set defaults.  
[default-config.sh](default-config.sh):
```bash
# Default configuration for tymr
FOREGROUND=false # Run timers in foreground by default
NO_SOUND=false   # Disable sound by default
SOUND_FILE=""    # Path to custom sound file, eg: "/path/to/sound.wav"
VOLUME=""        # Default volume

STATE_FILE="$HOME/.cache/tymr_state" # File to store timers' state
DELIMITER="|"                        # Delimiter for separating fields in the state file, must not be in timer names

# Sound player configuration. paplay, ffplay and mpv are already supported.
PLAYER_CMD=""           # Command to play sound
PLAYER_VOL_FLAG=""      # Volume flag for the player command (eg, "--volume ")
PLAYER_VOL_MULTIPLIER=1 # Multiplier for volume

NTFY_TOPIC="" # Default notification topic for ntfy.sh
```

tymr

tymr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tymr

tymr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README