update README.md
This commit is contained in:
parent
226456670a
commit
0ace1bcad2
21
README.md
21
README.md
|
@ -1,3 +1,22 @@
|
||||||
# Goat Monitor
|
# Goat Monitor
|
||||||
|
|
||||||
A command line tool for remotely monitoring command execution
|
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
|
||||||
|
|
||||||
|
```toml
|
||||||
|
server = "https://gotify.example.com"
|
||||||
|
app_token = "app_token_from_gotify"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
goat_monitor --config ./config.toml --retries -1 -- <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.
|
Loading…
Reference in New Issue
Block a user