Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jerluc/hermes
Never stare at console output again!
https://github.com/jerluc/hermes
command-line-tool notifications
Last synced: 24 days ago
JSON representation
Never stare at console output again!
- Host: GitHub
- URL: https://github.com/jerluc/hermes
- Owner: jerluc
- License: apache-2.0
- Created: 2015-12-10T01:48:16.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2022-05-21T00:35:43.000Z (over 2 years ago)
- Last Synced: 2024-11-05T20:41:15.611Z (2 months ago)
- Topics: command-line-tool, notifications
- Language: Go
- Size: 17.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hermes
Never stare at console output again! `hermes` allows you to take a break from staring at your
long-running command line process and will notify you when it completes or fails.
`hermes` currently supports the following notification types:
- [x] Desktop notification (`desktop`)
- [x] Twilio SMS message (`sms`)
- [x] Multi-channel notifications (`multi`)
- [ ] Twilio voice call
- [ ] Slack message
- [ ] Email
- [ ] ...more to come...
### Installation
```bash
go install github.com/jerluc/hermes@latest
```
### Configuring
To configure your Hermes notifications, create a `.hermes.yml` file in your user's home directory,
or in the current directory. Configuration files "closest" to the current working directory will
take precedence. A basic configuration for getting desktop notifications would look like:
```yaml
notifier:
type: desktop
```
For more example configurations, check out the [examples](examples)
directory.
### Usage
```bash
hermes [ARGS ... ]
```
For example:
```bash
# A successful command
hermes echo 'Hello, world!'
# A failing command
hermes cat /path/does/not/exist
```