Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

monitor-hafas-cli

1.2.0 • Public • Published

monitor-hafas-cli

Monitor any HAFAS endpoint from the command line.

npm version ISC-licensed minimum Node.js version chat with me on Gitter support me on Patreon

Installation

npm install -g monitor-hafas-cli

Or use npx. ✨

Getting started

As an example, we're going to monitor the BVG HAFAS endpoint, using bvg-hafas.

# make an empty project to play around 
mkdir bvg-monitoring
cd bvg-monitoring
npm init --yes
 
# set up HAFAS client 
npm install bvg-hafas
echo 'const createHafas = require("bvg-hafas")' >>hafas.js
echo 'const hafas = createHafas("bvg monitoring example")' >>hafas.js
echo 'module.exports = hafas' >>hafas.js
 
# set up monitoring 
events='departure'
stations='900000100001,900000100003'
 
# run monitor-hafas-cli using npx 
npx monitor-hafas-cli ./hafas.js $events stations $stations
# or install & run monitor-hafas-cli manually 
npm install monitor-hafas-cli
./node_modules/.bin/monitor-hafas ./hafas.js $events stations $stations

Usage

Monitoring stations:
    monitor-hafas <hafas-client> <list of events> stations <list of stations>
    monitor-hafas <hafas-client> <list of events> stations --file <file with stations>
    available events: departure, stopover, stats
Monitoring trips in a bounding box:
    monitor-hafas <hafas-client> <list of events> bbox <north> <west> <south> <east>
    available events: trip, new-trip, trip-obsolete, stopover, position, stats
Options:
    --file          -f  Read the list of stations from a JSON file.
    --pretty-print  -f  Pretty print data instead of JSON.
    --interval      -i  Query interval in seconds. Default: 30
    --show-stats    -s  Always show request stats.
Examples:
    monitor-hafas bvg-hafas departure stations 900000100001,900000100003
    monitor-hafas ./my-hafas-client.js departure,stopover stations --file stations.json
    monitor-hafas some-package/my-hafas-client.js stopover,position bbox 52.6 13.3 52.3 13.6

Contributing

If you have a question or need support using monitor-hafas-cli, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.

Install

npm i monitor-hafas-cli

DownloadsWeekly Downloads

6

Version

1.2.0

License

ISC

Unpacked Size

8.12 kB

Total Files

7

Last publish

Collaborators

  • avatar