/fish-done

A fish-shell package to automatically receive notifications when long processes finish.

Primary LanguageShellMIT LicenseMIT

done

A fish shell package to automatically receive notifications when long processes finish.

Stability: Stable Release version fish >=2.3.0 License: MIT


Just go on with your normal life. You will get a notification when a process takes more than 5 seconds finish, and the terminal window not in the foreground.

After installing you could type, for instance sleep 6, and start using other app. After 6 seconds you should get a notification.

Installation

Using Fisher

fisher install franciscolourenco/done

Manually

curl -Lo ~/.config/fish/conf.d/done.fish --create-dirs https://raw.githubusercontent.com/franciscolourenco/done/master/conf.d/done.fish

Arch Linux

Install the fish-done package from AUR.

yay -S fish-done

Dependencies

  • If you want notifications with icons on macOS, please install terminal-notifier with
brew install terminal-notifier

  • If you are using https://swaywm.org please install jq.

  • If you are using Windows Subsystem for Linux (WSL) you may need to install wslu, but usually it is pre-installed.

Updating

fisher update franciscolourenco/done

Settings

Only display notifications if a command takes more than a certain amount of time

set -U __done_min_cmd_duration 5000  # default: 5000 ms

Prevent specific commands from triggering notifications.

It accepts a list of regex patterns. This is useful to exclude commands like for instance git commit, since it could trigger unwanted notifications if it is configured to use an external editor. This is also useful with set -U __done_allow_nongraphical 1 to prevent notifications for commands normally run interactively that you do not want to get done notifications for.

set -U __done_exclude '^git (?!push|pull|fetch)'  # default: all git commands, except push and pull. accepts a regex.

You can add more exclude patterns to the existing ones by using the --append option:

set -U --append __done_exclude '^emacsclient'

Execute a custom command instead of showing the default notifications. The done notification title and message can also be passed.

set -U __done_notification_command "your-command \$title \$message"

Play sound when showing notifications.

set -U __done_notify_sound 1

When using sway, do not show notifications for visible windows.

set -U __done_sway_ignore_visible 1

For Linux, set the urgency level for notifications sent via notify-send (low, normal, critical). The default is "normal" for regular commands, and "critical" for failed commands.

set -U __done_notification_urgency_level low
set -U __done_notification_urgency_level_failure normal

Allow notifications to be sent on systems without graphical capabilities. Note this requires you to also set __done_notification_command.

set -U __done_allow_nongraphical 1

Notifications are unavailable under Wayland. However, if you are using Kitty, you can enable it by using Kitty's remote control.

You need to install jq.

In kitty.conf (change "kitty-rc-password" to your liking):

remote_control_password "kitty-rc-password" ls
allow_remote_control password

In fish

set -U __done_kitty_remote_control 1
set -U __done_kitty_remote_control_password "kitty-rc-password"

For Linux (except Ubuntu's Notify OSD), set the timeout in milliseconds at which to expire the notification. The default is "3000" (3 seconds). Set to "0" if you want it to never expire.

set -U __done_notification_duration 5000 # 5 seconds

Support

  • fish 2.3.0+
  • macOS 10.8+ via Notification Center.
  • Linux via notify-send. Otherwise bell sound is played.
  • Windows 10 via Windows Subsystem for Linux (WSL) and PowerShell.

Credits

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

Done is MIT licensed. See LICENSE for details.