goat_monitor/README.md

23 lines
660 B
Markdown
Raw Normal View History

2024-09-14 13:25:58 -06:00
# Goat Monitor
2024-09-14 13:40:27 -06:00
A command line tool for remotely monitoring command execution using Gotify.
Yes, I know Gotify doesn't have "goat" in its name but it sounds like it.
## Configuration
2024-09-14 17:46:39 -06:00
Configuration lives in a TOML file which should have (at a minimum) the following:
2024-09-14 13:40:27 -06:00
```toml
server = "https://gotify.example.com"
app_token = "app_token_from_gotify"
```
## Usage
```
2024-09-14 17:46:39 -06:00
goat_monitor --config ./config.toml --retries 3 -- <COMMAND TO MONITOR>
2024-09-14 13:40:27 -06:00
```
The command can be any shell command including arbitrarily many options / arguments.
Note that `--` is often necessary to prevent options within the monitored command from being parsed as options to goat_monitor.