https://github.com/rudeigerc/znotify

A simple Zsh plugin for sending notifications to other services
https://github.com/rudeigerc/znotify

notification zsh zsh-plugin

Last synced: 2 months ago
JSON representation

A simple Zsh plugin for sending notifications to other services

• Host: GitHub
• URL: https://github.com/rudeigerc/znotify
• Owner: rudeigerc
• License: mit
• Created: 2022-09-07T08:10:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-07T08:32:44.000Z (almost 2 years ago)
• Last Synced: 2024-01-25T17:35:31.249Z (5 months ago)
• Topics: notification, zsh, zsh-plugin
• Language: Shell
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-zsh-plugins - znotify - A simple plugin for sending notifications to other services. (Plugins / ZSH on Windows)
• fucking-awesome-zsh-plugins - znotify - A simple plugin for sending notifications to other services. (Plugins / ZSH on Windows)

README

        
# znotify

A simple Zsh plugin for sending notifications to other services.

## Installation

### oh-my-zsh

```shell

git clone https://github.com/rudeigerc/znotify ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/znotify

```

In `$HOME/.zshrc`:

```shell

plugins=(... znotify)

```

### Znap

```shell

znap source rudeigerc/znotify

```

### Manual Installation

```shell

source /path/to/znotify.plugin.zsh

```

## Usage

```shell

$ do something; znotify -s 

```

### Supported Services

- Telegram

- LINE

- Slack

- macOS Notification

## Required Environment Variables

- [Telegram](https://core.telegram.org/bots/api#sendmessage)

  - `ZNOTIFY_TELEGRAM_TOKEN`: Authentication token generated by @BotFather

  - `ZNOTIFY_TELEGRAM_CHAT_ID`: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

- [LINE](https://notify-bot.line.me/doc/en/)

  - `ZNOTIFY_LINE_TOKEN`: Authentication token

- [Slack](https://api.slack.com/methods/chat.postMessage)

  - `ZNOTIFY_SLACK_TOKEN`: Authentication token bearing required scopes

  - `ZNOTIFY_SLACK_CHANNEL`: Channel, private group, or IM channel to send message to

## License

MIT