botium-cli
Botium - The Selenium for Chatbots
Last updated 20 days ago by ftreml .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install botium-cli 
SYNC missed versions from official npm registry.

Botium CLI - The Selenium for Chatbots

NPM

Codeship Status for codeforequity-at/botium-cli npm version license

Botium is the Selenium for chatbots. Botium CLI is the swiss army knife of Botium.

IF YOU LIKE WHAT YOU SEE, PLEASE CONSIDER GIVING US A STAR ON GITHUB!

How do I get help ?

  • Read the Botium in a Nutshell series
  • If you think you found a bug in Botium, please use the Github issue tracker.
  • The documentation on a very technical level can be found in the Botium Wiki.
  • For asking questions please use Stackoverflow - we are monitoring and answering questions there.
  • For our VIP users, there is also a Slack workspace available (coming soon).

Installation

> npm install -g botium-cli

See below to see instructions how to use the Botium CLI docker image

Usage

Did you read the Botium in a Nutshell articles ? Be warned, without prior knowledge of Botium you won't be able to properly use this library!

Prepare and run a simple Botium test case:

> botium-cli init
> botium-cli run

Got get help on the command line options:

> botium-cli help

Botium Capabilities configuration

The chatbot capabilities are described in a configuration file. By default, the file named "botium.json" in the current directory is used, but it can be specified with the "--config" command line parameter. The configuration file holds capabilities, envs and sources. Configuration via environment variables is supported as well.

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "botium-sample1",
      ....
    },
    "Sources: {
      ....
    },
    "Envs": {
      "NODE_TLS_REJECT_UNAUTHORIZED": 0,
      ....
    }
  }
}

Commands

botium-cli init

Prepare a directory for Botium usage:

  • Adds a simple botium.json
  • Adds a sample convo file

botium-cli init-dev [connector|asserter|logichook]

Setup a boilerplate development project for Botium connectors, asserters or logic hooks in the current directory:

  • Adds a Javascript source file with the skeleton code
  • Adds a botium.json with connector/asserter/logic hook registration
  • Adds a sample convo file

botium-cli run

Automatically run all your scripted conversations against your chatbot and output a test report

botium-cli nlpanalytics <algorithm>

Runs NLP analytics with the selected algorithm.

  • validate - run one-shot training and testing of NLP engine
  • k-fold - run k-fold training and testing of NLP engine

See this article for further information.

botium-cli nlpextract

Extract utterances from selected Botium connector and write to Botium Utterances files. Supported not by all connectors, please check connector documentation. Supported amongst others by:

  • Dialogflow
  • IBM Watson
  • Amazon Lex
  • Wit.ai
  • NLP.js

and more to come.

botium-cli *import

Import conversation scripts or utterances from some source (for example, from IBM Watson workspace)

botium-cli inbound-proxy

Launch an HTTP/JSON endpoint for inbound messages, forwarding them to Redis to make them consumable by Botium Core.

See Botium Wiki how to use.

botium-cli emulator

The Botium Console Emulator is a basic command line interface to your chatbot running within Botium. You can record and save your conversation files.

Botium Console Emulator

Running it is simple:

$ botium-cli emulator console

Using the Botium CLI docker image

Instead of installing the NPM package, you can use the Botium CLI docker image instead:

$ docker run --rm -v $(pwd):/app/workdir botium/botium-cli

You can use all commands as described above. Special considerations:

  • You cannot use absolute pathes, but all pathes should be given relative to the current working directory. The current working directory is mapped to the docker container with the -v switch (above this is mapped to the current working directory)
  • For running the console emulator, you will have to add the -it flag to the docker command to enable terminal interactions:
$ docker run --rm -v $(pwd):/app/workdir -it botium/botium-cli emulator console

Usage under Windows

When using the above command under Windows, especially with git bash, you may receive an error like this:

C:\Program Files\Docker\Docker\Resources\bin\docker.exe: Error response from daemon: Mount denied:
The source path "C:/dev/xxxxx;C"
doesn't exist and is not known to Docker.

In this case you have to disable the bash path conversion:

 > export MSYS_NO_PATHCONV=1

Current Tags

  • 0.0.68                                ...           latest (20 days ago)

68 Versions

  • 0.0.68                                ...           20 days ago
  • 0.0.67                                ...           2 months ago
  • 0.0.66                                ...           3 months ago
  • 0.0.65                                ...           4 months ago
  • 0.0.64                                ...           4 months ago
  • 0.0.63                                ...           5 months ago
  • 0.0.62                                ...           6 months ago
  • 0.0.61                                ...           6 months ago
  • 0.0.60                                ...           7 months ago
  • 0.0.59                                ...           7 months ago
  • 0.0.58                                ...           7 months ago
  • 0.0.57                                ...           7 months ago
  • 0.0.56                                ...           8 months ago
  • 0.0.55                                ...           9 months ago
  • 0.0.54                                ...           9 months ago
  • 0.0.53                                ...           10 months ago
  • 0.0.52                                ...           10 months ago
  • 0.0.51                                ...           a year ago
  • 0.0.50                                ...           a year ago
  • 0.0.49                                ...           a year ago
  • 0.0.48                                ...           a year ago
  • 0.0.47                                ...           a year ago
  • 0.0.46                                ...           a year ago
  • 0.0.45                                ...           a year ago
  • 0.0.44                                ...           a year ago
  • 0.0.43                                ...           a year ago
  • 0.0.42                                ...           a year ago
  • 0.0.41                                ...           a year ago
  • 0.0.40                                ...           a year ago
  • 0.0.39                                ...           a year ago
  • 0.0.38                                ...           a year ago
  • 0.0.37                                ...           a year ago
  • 0.0.36                                ...           a year ago
  • 0.0.35                                ...           a year ago
  • 0.0.34                                ...           a year ago
  • 0.0.33                                ...           a year ago
  • 0.0.32                                ...           2 years ago
  • 0.0.31                                ...           2 years ago
  • 0.0.30                                ...           2 years ago
  • 0.0.29                                ...           2 years ago
  • 0.0.28                                ...           2 years ago
  • 0.0.27                                ...           2 years ago
  • 0.0.26                                ...           2 years ago
  • 0.0.25                                ...           2 years ago
  • 0.0.24                                ...           2 years ago
  • 0.0.23                                ...           2 years ago
  • 0.0.22                                ...           2 years ago
  • 0.0.21                                ...           2 years ago
  • 0.0.20                                ...           2 years ago
  • 0.0.19                                ...           2 years ago
  • 0.0.18                                ...           2 years ago
  • 0.0.17                                ...           2 years ago
  • 0.0.16                                ...           2 years ago
  • 0.0.15                                ...           2 years ago
  • 0.0.14                                ...           2 years ago
  • 0.0.13                                ...           2 years ago
  • 0.0.12                                ...           2 years ago
  • 0.0.11                                ...           2 years ago
  • 0.0.10                                ...           2 years ago
  • 0.0.9                                ...           2 years ago
  • 0.0.8                                ...           2 years ago
  • 0.0.7                                ...           2 years ago
  • 0.0.6                                ...           2 years ago
  • 0.0.5                                ...           2 years ago
  • 0.0.4                                ...           2 years ago
  • 0.0.3                                ...           2 years ago
  • 0.0.2                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 14
Last Day 0
Last Week 0
Last Month 2
Dependents (1)

Copyright 2014 - 2016 © taobao.org |