alexdelorenzo / onhold

🔊 Play sounds while and after shell jobs complete

🔊 Play sounds while and after shell jobs complete

onhold is a command-line utility that allows you to play music while a long job completes.

ding is command-line utility that will play a sound after a long job completes.

Both utilities will take data that is piped into their standard inputs and pipe it to standard output. That is to say that data piped into onhold and ding will be piped right back out.

$ echo "Hello!" | onhold
Hello!

As a result, you can build pipelines with onhold and ding.

For example, you can download an ISO with http, visualize the progress with pv, play music with onhold while writing to /dev/null, and when it's finished, play a sound with ding.

$ export URL="http://releases.ubuntu.com/releases/21.04/ubuntu-21.04-desktop-amd64.iso"
$ http "$URL" | pv | onhold | ding > /dev/null

This project uses play_sounds, a wrapper over playsound and boombox.

onhold

You can either set the $ONHOLD environment variable to the song you'd like to play, or supply the song with the -s flag.

$ export ONHOLD="~/Music/song.mp3"
$ pv /dev/zero | onhold > /dev/null

This allows you to set $ONHOLD in your ~/.bashrc.

You can also specify it with a flag.

$ pv /dev/zero | onhold -s song.mp3 > /dev/null

onhold comes with a default song that will play if neither $ONHOLD or -s are set. You can use the -w flag to show warnings if $ONHOLD or -s are not set.

$ echo "Hello!" | onhold
Hello!

ding

You can either set the $DING environment variable to the sound you'd like to play, or supply the sound with the -s flag.

# You can run ding after a command or as part of a pipeline
$ export DING="~/Music/ding.mp3"
$ sleep 5; ding
$ echo "Hello!" | ding
Hello!

This allows you to set $DING in your ~/.bashrc.

You can also specify it with a flag.

$ echo "Hello!" | ding -s ding.mp3
Hello!

ding comes with a default sound that will play if neither $DING or -s are set. You can use the -w flag to show warnings if $DING or -s are not set.

$ echo "Hello!" | ding
Hello!

ding is its own package, too

You can install ding by itself. Future versions of onhold will not ship with ding. Click here to visit ding's project page with installation instructions.

Installation

Dependencies

• A Unix shell like Bash, or PowerShell or Command Prompt on Windows
• Python 3.6+
• requirements.txt

Linux

You'll need to install GStreamer on Linux, or the play binary from sox.

Ubuntu

On Ubuntu, you will need to install PyGObject, gstreamer1.0-python3-plugin-loader and python3-gst-1.0.

$ sudo apt install python3-gi gstreamer1.0-python3-plugin-loader python3-gst-1.0

Arch

On Arch, you can install onhold or onhold-git and its prerequisites directly from the AUR. Thanks, @jfrcom!

$ yay -S onhold # replace yay with your aur helper

PyPI

$ python3 -m pip install onhold

GitHub

$ python3 -m pip install -r requirements.txt
$ python3 setup.py install

Help

onhold

$ onhold --help
Usage: onhold [OPTIONS]

  Play the specified sound file while data is passed in through standard
  input and passed through standard output.

Options:
  -s, --sound_path PATH  Path to sound to play.
  -b, --bell             Ring the terminal bell, as well.  [default: False]
  -w, --warn             Show warnings.
  --help                 Show this message and exit.

ding

$ ding --help
Usage: ding [OPTIONS]

  Play specified sound after job is complete.

Options:
  -s, --sound_path PATH  Path to sound to play.
  -b, --bell             Ring the terminal bell, as well.  [default: False]
  -w, --warn             Show warnings.
  --help                 Show this message and exit.

Support

Want to support this project and other open-source projects like it?

License

See LICENSE. If you'd like to use this project with a different license, please get in touch.