Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luismayta/zsh-notify

Get notified when your command is done
https://github.com/luismayta/zsh-notify

autoinstall automation notify peru r2d2 zsh

Last synced: 3 months ago
JSON representation

Get notified when your command is done

Host: GitHub
URL: https://github.com/luismayta/zsh-notify
Owner: luismayta
License: lgpl-3.0
Created: 2020-01-06T00:53:18.000Z (about 5 years ago)
Default Branch: develop
Last Pushed: 2024-10-29T19:03:39.000Z (3 months ago)
Last Synced: 2024-10-29T21:16:10.316Z (3 months ago)
Topics: autoinstall, automation, notify, peru, r2d2, zsh
Language: Makefile
Homepage:
Size: 2.52 MB
Stars: 12
Watchers: 3
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
- Support: docs/support.md

Awesome Lists containing this project

README

# zsh-notify

[![GitHub release](https://img.shields.io/github/release/luismayta/zsh-notify?style=flat-square)](https://github.com/luismayta/zsh-notify/releases/latest) [![Lint](https://img.shields.io/github/workflow/status/luismayta/zsh-notify/lint-code)](https://github.com/luismayta/zsh-notify/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/luismayta/zsh-notify/ci)](https://github.com/luismayta/zsh-notify/actions?workflow=ci) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com)

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:

- [zsh-core](https://github.com/hadenlabs/zsh-core)

## Installation

### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users

If you're using [oh-my-zsh](https://gitub.com/robbyrussell/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-notify`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-notify )` to your list of plugins
4. Open a new terminal and enjoy!

### [antigen](https://github.com/zsh-users/antigen) users

If you're using [Antigen](https://github.com/zsh-users/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](https://github.com/getantibody/antibody) users

If you're using [Antibody](https://github.com/getantibody/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.

2. 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.
3. 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](https://github.com/luismayta/zsh-notify/issues).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/luismayta/zsh-notify/issues) 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)](https://semver.org/).

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

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. 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

## 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.](LICENSE).

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

[Your feedback is appreciated](https://github.com/luismayta/zsh-notify/issues)