@cloudchipr/cloudchipr-engine

cloudchipr-engine

The CloudchiprEngine library exported as Typescript module

Prerequisites

• Node
• Python

Installation

Using npm:

$ npm i -g npm
$ npm i cloudchipr-engine

Note: add --save if you are using npm < 5.0.0

Usage

import {AdapterInterface, ShellAdapter, Configuration, AdapterInterface, FindGarbageResponse} from "cloudchipr-engine";

const config = new Configuration(ACCESS_KEY_ID, SECRET_ACCESS_KEY)
const adapter: AdapterInterface = new ShellAdapter(CUSTODIAN)
const garbageResponse: FindGarbageResponse = adapter.findGarbage(config);

Development

After making a change, do the following
Run:

$ npm run format && npm run lint

Fix all the errors if there is any

Change the version in the package.json file and run

$ npm run build

Push the changes to GitHub

In order to publish your package, you need to create an NPM account.
If you don’t have an account you can do so on NPM or run the command:

$ npm adduser

If you already have an account, just login to you NPM account.

$ npm login

Publish the package

$ npm publish