# @dvrylc/sentinel

> A command-line site monitor

Latest version **1.0.4** (published 2018-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dvrylc/sentinel
pnpm add @dvrylc/sentinel
yarn add @dvrylc/sentinel
bun add @dvrylc/sentinel
```

Provides the command `sentinel`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2018-03-20 |
| First published | 2018-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Daryl Chan |
| Maintainers | dvrylc |

## Links

- npm: https://www.npmjs.com/package/@dvrylc/sentinel
- Repository: https://github.com/dvrylc/sentinel
- Homepage: https://github.com/dvrylc/sentinel#readme
- Issues: https://github.com/dvrylc/sentinel/issues
- npm.io page: https://npm.io/package/@dvrylc/sentinel

## Dependencies (6)

- [ora](https://npm.io/package/ora.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [yesno](https://npm.io/package/yesno.md) 0.0.1
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [commander](https://npm.io/package/commander.md) ^2.15.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.1.1

## Recent versions

- 1.0.4 (latest) — 2018-03-20
- 1.0.3 — 2018-03-19
- 1.0.2 — 2018-03-19
- 1.0.1 — 2018-03-19
- 1.0.0 — 2018-03-19

## README

# Sentinel

[![npm (scoped)](https://img.shields.io/npm/v/@dvrylc/sentinel.svg)](https://www.npmjs.com/package/@dvrylc/sentinel) ![license](https://img.shields.io/github/license/dvrylc/sentinel.svg)

A command-line site monitor

<img src="https://i.imgur.com/xMIiGwQ.gif">

## 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

---
_Source: https://npm.io/package/@dvrylc/sentinel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._