Skip to content
This repository has been archived by the owner on Nov 24, 2019. It is now read-only.
/ qix-info Public archive

Library & CLI to get some information from QIX using enigma.js.

License

Notifications You must be signed in to change notification settings

stefanwalther/qix-info

Repository files navigation

qix-info

CircleCI

Library & CLI to get some information from QIX using enigma.js.


About

A super simple & minimalistic library & CLI to get some information out of the QIX engine.
Ideal for some prototyping work.

Installation

As a library

$ npm install qix-info --save-dev

As a command line tool

$ npm install qix-info -g

As a Docker container

$ docker pull stefanwalther/qix-info

Usage

As a library

const QixInfo = require('qix-info');

(async () => {
  let qixInfo = new QixInfo();
  let apps = await qixInfo.listApps();
  console.log(`Amount of apps: ${apps.length}`);
})();

CLI

List all apps:

$ qix-info --host localhost:9076 list-apps

Command: list-apps

Docker container

$ docker run --net="host" stefanwalther/qix-info list-apps

Note: We need to add --net="host" to allow the Docker container talking to the host.

Roadmap

I might want to add more functionality over time (e.g. such as the healthcheck endpoint, listing extensions, etc.), but only as needed.

Feel free to extend this library and adding a pull request.

Author

Stefan Walther

License

MIT


This file was generated by verb-generate-readme, v0.6.0, on February 05, 2018.