Rickie CLI App

This Command Line Interface (CLI) App is designed in a way developers can interact with Rickie system.

To get started, install it running one of the following commands in a terminal:

# If you use npm
npm install -g rickie-cli

# If you use yarn
yarn global install rickie-cli

# If you use volta
volta install rickie-cli

Signin

To access private resource you first need to sign in running the following command:

rickie signin --email my@email.com --password "mypassword with white spaces"

You should se a welcome message in case of success.

Get Report

To get your current performance report just run the following while signed in:

rickie report

Implementing an Alert Bot

You can implement an alert bot using javascript language. To do so first a new javascript project running the following on your terminal:

mkdir -p /path/to/my-bot
cd /path/to/my-bot
yarn init

fulfill all info required by yarn and then install rickie package running the following:

yarn install rickie

Then create an index.js file with the following:

const rickie, { Watcher } = require("rickie");

const watcher = new Watcher(/* config */);

const candlesList = [];

watcher.on("candle_1min:created", ({ asset, price, dayChangePercent }) => {
  if (dayChangePercent > 1) {
    /**
     * If current price changes more than 1% from last day
     * price create an alert for me.
     */
    rickie.alert("Compra");
  }
});

Finally deploy your bot running the following:

rickie bot deploy /path/to/my-bot

After a little time you should see a confirmation message.