Build chatbots using React
Clone or download

README.md

botonic

Build chatbots using React

Version CircleCI Appveyor CI Codecov Downloads/week License

Usage

$ npm install -g botonic
$ botonic COMMAND
running command...
$ botonic (-v|--version|version)
botonic/0.4.1 darwin-x64 node-v9.9.0
$ botonic --help [COMMAND]
USAGE
  $ botonic COMMAND
...

Commands

botonic deploy [BOT_NAME]

Deploy Botonic project to botonic.io cloud

USAGE
  $ botonic deploy [BOT_NAME]

EXAMPLE
  $ botonic deploy
  Building...
  Creating bundle...
  Uploading...
  🚀 Bot deployed!

See code: src/commands/deploy.ts

botonic help [COMMAND]

display help for botonic

USAGE
  $ botonic help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

botonic input INPUT

Get response from a single input

USAGE
  $ botonic input INPUT

OPTIONS
  -c, --context=context  Context of current session
  -p, --path=path        Path to botonic project. Defaults to current dir.
  -r, --route=route      Route of the current bot state.

EXAMPLE
  $ botonic input "{\"type\": \"text\", \"data\": \"hi\"}"
  Hello!

See code: src/commands/input.ts

botonic login

Log in to Botonic

USAGE
  $ botonic login

OPTIONS
  -p, --path=path  Path to botonic project. Defaults to current dir.

See code: src/commands/login.ts

botonic logout

Log out of Botonic

USAGE
  $ botonic logout

OPTIONS
  -p, --path=path  Path to botonic project. Defaults to current dir.

See code: src/commands/logout.ts

botonic new NAME [TEMPLATENAME]

Create a new Botonic project

USAGE
  $ botonic new NAME [TEMPLATENAME]

ARGUMENTS
  NAME          name of the bot folder
  TEMPLATENAME  OPTIONAL name of the bot template

EXAMPLE
  $ botonic new test_bot
  Creating...
  ✨ test_bot was successfully created!

See code: src/commands/new.ts

botonic run [INPUT]

Start interactive session

USAGE
  $ botonic run [INPUT]

OPTIONS
  -p, --path=path  Path to botonic project. Defaults to current dir.

EXAMPLE
  $ botonic run
  Your bot is ready, start talking:
  [you] > Hi
  [bot] > Bye!

See code: src/commands/run.ts

botonic webview WEBVIEW_PAGE

Get response from a single input

USAGE
  $ botonic webview WEBVIEW_PAGE

OPTIONS
  -c, --context=context  Context of current session
  -p, --path=path        Path to botonic project. Defaults to current dir.

EXAMPLE
  $ botonic webview webview_hello"
  Hello!

See code: src/commands/webview.ts