<h1 align="center">
<br>
<img src="https://raw.githubusercontent.com/pando85/timer/main/assets/logo.svg" alt="logo" width="200">
<br>
Timer
<br>
<br>
</h1>
<p align="center">
<img src="https://raw.githubusercontent.com/pando85/timer/main/assets/demo.gif" alt="demo">
</p>


Simple count down terminal alarm.
- [Features](#features)
- [Installation](#installation)
- [Cargo](#cargo)
- [Archlinux](#archlinux)
- [Binaries](#binaries)
- [Beep](#beep)
- [Terminal bell](#terminal-bell)
## Features
- Multiple input options
- Play sound when finished (Beep included!)
- Send terminal bell
- Big centered output
## Installation
### Cargo
```bash
cargo install timer_core
```
### Archlinux
```bash
yay -S timer-rs
```
### Binaries
Binaries are made available each release for the Linux and MacOS operating systems.
You can download a prebuilt binary from our [Releases](https://github.com/pando85/timer/releases).
```bash
curl -s https://api.github.com/repos/pando85/timer/releases/latest \
| grep browser_download_url \
| grep $(uname -m) \
| grep linux \
| cut -d '"' -f 4 \
| xargs curl -L \
| tar xvz
sudo mv timer /usr/local/bin
```
## Beep
If you want to enable beep from your built-in case speaker you will need to run one of these
kernel modules: `pcspkr` (recommended) or `snd-pcsp`.
In addition, to use beep as normal user read the [`PERMISSIONS.md`](PERMISSIONS.md) file.
## Terminal bell
If executed with `-t, --terminal-bell` option it will send a bell character. Same as:
```bash
echo -e '\a'
```
This is useful for visual bell. Remember that you have to enable it in your terminal configuration.
Usage example:
```bash
timer -t -s 11:00
```