________  ___       _______   ________  _________    ___    ___ 
|\   __  \|\  \     |\  ___ \ |\   __  \|\___   ___\ |\  \  /  /|
\ \  \|\  \ \  \    \ \   __/|\ \  \|\  \|___ \  \_| \ \  \/  / /
 \ \   __  \ \  \    \ \  \_|/_\ \   _  _\   \ \  \   \ \    / / 
  \ \  \ \  \ \  \____\ \  \_|\ \ \  \\  \|   \ \  \   \/  /  /  
   \ \__\ \__\ \_______\ \_______\ \__\\ _\    \ \__\__/  / /    
    \|__|\|__|\|_______|\|_______|\|__|\|__|    \|__|\___/ /     
                                                    \|___|/

Alerty lets you jumpscare yourself using only the terminal. Oh and ig it can be used to time stuff as well. Shoutout to all my pomodoro homies. (Now it annoys you on the phone as well!!)

---

Features

• Set an alarm for any duration using hours, minutes, and/or seconds.
• Customize the alarm sound, or use the default sound provided.
• Send a desktop notification when the alarm triggers (Linux notify-send required).
• Run alarms as background processes so that the terminal remains usable.
• Optional message customization for the notification pop-up.
• Broadcast alerts to other devices using kdeconnect.

Installation

To install Alerty and make it globally accessible, follow these steps:

1. Clone the repository:

   git clone https://github.com/sinhSlumbering/alerty.git
   cd alerty

2. Make the install script executable:

   chmod +x ./install.sh

3. Run the installation script with sudo:

   sudo ./install.sh

4. Verify the installation by running:

   alerty --help

Usage

You can set alarms with flexible timing options. Here’s how to use alerty:

Usage: alerty [OPTIONS]

Options:
  -h <hours>            Set hours for the alarm timer.
  -m <minutes>          Set minutes for the alarm timer.
  -s <seconds>          Set seconds for the alarm timer.
  -f <track>            Specify a custom alarm sound file.
  -df <track>           Set a default alarm sound file (used if -f is not specified).
  -sm, --set-message    Set a custom notification message.
  -dm, --default-message      Set a new default message for future alarms.
  -eb, --enable-broadcast     Enables alert broadcast to registered devices
  -db, --disable-broadcast    Disable broadcast to registered devices
  -ri, --register-id          Register a device by device id.
  -rn, --register-name        Register a device by device name
  -rd, --remove-device        Remove a device from Broadcast list
  --status              Check if an alarm is running.
  --stop                Stop the currently running alarm.
  --help                Display this help message.

Examples

• Set an alarm for 45 seconds with a custom sound:

  alerty -s 45 -f /path/to/custom/sound.mp3

• Set an alarm with a custom notification message:

  alerty -s 10 -sm "Time's up!"

Broadcast notifications

• Assuming you have kdeconnect installed, reachable devices can be found with:

  kdeconnect-cli -l

• This should output something like this:

  -<name>: <id> (paired and reachable)
  1 device found

• We can register this device with either the name or the id.

  alerty -rn <name>
  alerty --register-name <name>
  alerty -ri <id>
  alerty -register-id <id>

• Finally we can enable/disable broadcasts by:

  alerty --enable-broadcast
  alerty -eb
  alerty --disable-broadcast
  alerty -db

Requirements

• Linux (tested on arch btw)

• ffmpeg :

  # Arch Derivatives
  sudo pacman -S ffmpeg
  # For Debian based distros
  sudo apt install ffmpeg

• notify-send: For desktop notifications. Install via libnotify-bin package:

  # Arch derivatives
  sudo pacman -S libnotify
  # For Debian based distros 
  sudo apt install libnotify-bin

• kdeconnect-cli on your PC and on your target device for message Broadcast.

  # Arch derivatives
  sudo pacman -S kdeconnect
  # For Debian based distros 
  sudo apt install kdeconnect

Uninstallation

To nuke alerty use the uninstall.sh script

  chmod +x uninstall.sh
  ./uninstall.sh

Or just do it manually with:

sudo rm /usr/local/bin/alerty
sudo rm -rf /usr/local/share/alerty
sudo rm -r $HOME/.config/alerty

---

Embrace the kamla with alerty! 🎶⏰