bi-service-cli

2.0.1 • Public • Published

Build Status

Provides a bi-service based App which spies on AppManager's apps to provide integrity status of the running service.

Integration

 
var Service = require('bi-service').Service;
 
//your service definition
module.exports = new Service;
 
//hookup the plugin to the bi-service
require('bi-service-cli');

Require the plugin module preferably at the bottom of your index.js file of your project (aka. where your Service definition should be)

bi-service project config

Add the cli app

{
    listen: {
        cli: {
            port: '3000'
        }
    },
    apps: {
        //It expects the app to be under "apps.cli" name
        cli: {
            baseUrl: {$join: [
                'http://127.0.0.1:',
                {$ref: '#listen/cli/port'}
            ]},
            listen: {$ref: '#listen/cli/port'},
            show: false //if true - attaches REPL node console to the service process
        }
    }
}

TIP: When you want to quickly show the REPL console and editing of the config file is not desirable, you can override the config option inline like so:

node bin/www apps.cli.show 1

Using the console

After you are connected to the console. The help command is your friend.
Use it to get an overview of available commands and their usage

REST API

GET /api/v1.0/integrity - responds with 409 status in case of integrity error or 200 signalizing all OK.

Readme

Keywords

Package Sidebar

Install

npm i bi-service-cli

Weekly Downloads

3

Version

2.0.1

License

GPL-3.0

Unpacked Size

65.4 kB

Total Files

14

Last publish

Collaborators

  • bistudio