Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dvrylc/sentinel
A command-line site monitor
https://github.com/dvrylc/sentinel
command-line monitoring site-monitor uptime-monitor
Last synced: 16 days ago
JSON representation
A command-line site monitor
- Host: GitHub
- URL: https://github.com/dvrylc/sentinel
- Owner: dvrylc
- License: mit
- Created: 2018-03-18T04:38:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-03-20T13:04:13.000Z (over 6 years ago)
- Last Synced: 2024-03-23T18:01:54.711Z (9 months ago)
- Topics: command-line, monitoring, site-monitor, uptime-monitor
- Language: JavaScript
- Homepage:
- Size: 692 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - dvrylc/sentinel - A command-line site monitor (monitoring)
README
# Sentinel
[](https://www.npmjs.com/package/@dvrylc/sentinel) 
A command-line site monitor
## Installation
Sentinel requires Node.js v8.5 and above. To check your Node.js version, run `node -v`.
```console
$ npm install -g @dvrylc/sentinel
```
## Usage
```
$ sentinel [options]
A command-line site monitor
Config file: path/to/your/config/file
Options:
-V, --version output the version number
-s, --setup setup config file in the home directory
-h, --help output usage information
```
## Configuration
Sentinel relies on a config file for the list of sites to monitor, as well as some user-configurable settings.
When you first run Sentinel, it will prompt you to setup a config file in your home directory.
Subsequently, to locate the config file, run `sentinel -h`.
To start afresh, run `sentinel -s`. Sentinel will prompt you to replace your existing config file with a fresh one.
### Configuration fields
The config file should always be a valid JSON object.
- `sites (array)`: Array of absolute (`http` or `https`) URLs to monitor
## License
MIT