botfuel-cli/README.md

Command Line Interface for Botfuel-dialog

# Botfuel CLI

Botfuel-dialog command line utility.

# Features

# Installation
```shell
npm install -g botfuel-cli
```

# Usage

## Create a new project

```shell
fuel new my-new-bot
````

## Generate files

```shell
fuel generate <command>
```

## Generate view

```shell
fuel generate view <name>
```

## Generate Dialog

```
fuel generate dialog <name> [entities..] [--type=]

Generating dialog <name> of type [type] with [entities]

Options:
  --type     Dialog type (void, base, default, qna,
             confirmation)            [default: "default"]
```

### Example

```shell
fuel generate dialog travel destination:city pilot:forename --type=prompt
```


## Generate Intents

The intent generation with :
 - generate the dialog file
 - generate the view file
 - call the botfuel API to create the intent in the trainer

```shell
fuel generate intent <name>
```


## Generate Config

```shell
fuel g config <name> [options]

Generate config <name>

Options:
  --adapter  Adapter to use (test, botfuel, shell, messenger ...)
                                                              [default: "shell"]
  --brain    Brain to use (memory, mongo)
  --locale   Locale to use (en, fr, en)
  --logger   Logger to use (debug, info, error)
  --modules  List of modules used (botfuel-module-facetedsearch, ...)
```

### Example
```shell
fuel g c botfuel --adapter=botfuel --brain=mongo --locale=en --logger=info --modules="foo bar"
```

## Run bot

```shell
fuel serve <config>
```

### Example
```shell
fuel generate config webchat --adapter=botfuel --loger=debug
fuel serve webchat
```

## Run tests

```shell
fuel test
```