# Recime Command Line Interface

## This package is no longer maintained. Please reach us: admin@recime.io

Create, debug and publish modules (coming soon) for a rich chatbot experience using the Command Line Interface.

[![Build Status](https://travis-ci.org/Recime/nodejs-cli.svg?branch=master)](https://travis-ci.org/Recime/nodejs-cli)
[![npm version](https://badge.fury.io/js/recime.svg)](https://badge.fury.io/js/recime)


## Installation
Install `recime` globally by typing the following command:

```bash
npm install -g recime

```

## Get Started

### Setup

Login to your `Recime` account by typing the following in your terminal:

```bash
rbp login
```

You can create your free [account here](https://console.recime.io)

### Create your bot


Create the bot by typing the following command:

```bash
rbp create my-folder
```

This will take you through a small wizard and the create the bot in your [dashboard](https://console.recime.io) and generate the necessary config files to run the bot locally in the specific folder.

### Publish 

To publish your bot, type the following command:

```bash
rbp publish
```

This will update the bot with local `icon.png`. if the bot is configured for facebook, viber or telegram, then it will override with local configuration.

The recommended icon size for a bot is 80x80.

---

Check out [Documentation](https://docs.recime.io) on how to get started with `Recime` platform.


## Credits

Recime CLI make use of the following npm packages:

* [caporal.js](https://github.com/mattallty/Caporal.js) for cli.
* [chalk](https://www.npmjs.com/package/chalk) for colors
* [grpc](https://www.npmjs.com/package/grpc) for deploying.


## License

Copyright 2018 The Recime Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless 261d by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.