Skip to content

Commit

Permalink
📝 how to use shell integration
Browse files Browse the repository at this point in the history
  • Loading branch information
dschep committed Feb 20, 2016
1 parent 8e9528a commit b08bb24
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,24 @@ Usage
# this send the message '"sleep 10" succeeded in 0:10 minutes'
ntfy done sleep 10

Shell integration
~~~~~~~~~~~~~~~~~~~~
``ntfy`` has support for **automatically** sending notifications when long
running commands finish in Bash and ZSH. To enable it add the following to your
``.bashrc`` or ``.zshrc``:

::

eval $(ntfy shell-integration)

By default it will only send notifications for commands lasting longer than 30
seconds. This can be configured with the ``AUTO_NTFY_DONE_TIMEOUT`` environment
variable.

To avoid unnecessary notifications when running interactive programs
programs listed in ``AUTO_NTFY_DONE_IGNORE`` don't generat notifications.


Backends
--------

Expand Down

0 comments on commit b08bb24

Please sign in to comment.