goat_monitor/README.md
Brendan Haines 2668a880ee
Some checks failed
Python package / lint (push) Successful in 7s
Publish Python 🐍 distribution 📦 to PyPI and TestPyPI / Build distribution 📦 (push) Successful in 8s
Publish Python 🐍 distribution 📦 to PyPI and TestPyPI / Publish Python 🐍 distribution 📦 to PyPI (push) Has been skipped
Publish Python 🐍 distribution 📦 to PyPI and TestPyPI / Publish Python 🐍 distribution 📦 to TestPyPI (push) Failing after 3s
formatting
2024-09-14 23:05:50 -06:00

23 lines
660 B
Markdown

# Goat Monitor
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
Configuration lives in a TOML file which should have (at a minimum) the following:
```toml
server = "https://gotify.example.com"
app_token = "app_token_from_gotify"
```
## Usage
```
goat_monitor --config ./config.toml --retries 3 -- <COMMAND TO MONITOR>
```
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.