🔥

Zsh Notify (luismayta)

Get notified when your command is done

luismayta
|
8 stars
0

zsh-notify

GitHub release Lint CI Conventional Commits KeepAChangelog

zsh-notify plugin for zsh with auto install and sound of r2d2.

Features

  • auto install dependencies
  • sound of r2d2 for success and error commands

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

Installation

oh-my-zsh users

If you're using oh-my-zsh, install this plugin by doing the following:

  1. Go to your oh-my-zsh custom plugins directory -cd ~/.oh-my-zsh/custom/plugins
  2. Clone the plugin bash git clone https://github.com/luismayta/zsh-notifybash
  3. Edit your .zshrc and add plugins=( ... zsh-notify ) to your list of plugins
  4. Open a new terminal and enjoy!

antigen users

If you're using Antigen, install this plugin by doing the following:

  1. Add antigen bundle luismayta/zsh-notify to your .zshrc where you're adding your other plugins.
  2. Either open a new terminal to force zsh to load the new plugin, or run antigen bundle luismayta/zsh-notify in a running zsh session.
  3. Enjoy!

antibody users

If you're using Antibody, install this plugin by doing the following:

  1. Add :

{.sourceCode .bash} antibody bundle luismayta/zsh-notify branch:develop

to your .zshrc where you're adding your other plugins.

  1. Either open a new terminal to force zsh to load the new plugin, or run antibody bundle luismayta/zsh-notify in a running zsh session.
  2. Enjoy!

Usage

The only thing that is needed is to add it to your ZSH configuration

Functions

Help

Got a question?

File a GitHub issue.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to rebase the latest changes from "upstream" before making a pull request!

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

  1. Use the MAJOR version for incompatible changes.
  2. Use the MINOR version when adding functionality in a backwards compatible manner.
  3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright © 2018-2021 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like zsh-notify

Your feedback is appreciated