Skip to content

bot-compiler/botc

Repository files navigation

botc

CLI to create Chat bots using Bot Compiler

Version License

Usage

$ npm install -g botc
$ botc COMMAND
running command...
$ botc (-v|--version|version)
botc/1.4.0 linux-x64 node-v10.0.0
$ botc --help [COMMAND]
USAGE
  $ botc COMMAND
...

Commands

botc build

initial scaffolding from bot.atmt.json

USAGE
  $ botc build

OPTIONS
  -d, --dialogflow  use dialogflow

EXAMPLE
  $ botc build

See code: src/commands/build.ts

botc help [COMMAND]

display help for botc

USAGE
  $ botc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

botc init

create bot.json and functions.json

USAGE
  $ botc init

OPTIONS
  -n, --name=name  name of the bot

EXAMPLE
  $ botc init --name bot_name
  creating bot.json

See code: src/commands/init.ts

botc rebuild

apply changes in bot.atmt.json, preserve function implementations in *Impl.js files

USAGE
  $ botc rebuild

OPTIONS
  -d, --dialogflow  use dialogflow

EXAMPLE
  $ botc rebuild

See code: src/commands/rebuild.ts

  • [botc init]
  • [botc build]
  • [botc rebuild]

VSCode extension

Get VSCode extension here to start writing Bot Compiler schema with intellisense

Quickstart

Gmail Filter creator - Chat bot for pizza ordering

botc init -n [BotName]

describe the command here create bot.json and functions.json


USAGE
  $ botc init

OPTIONS
  -n, --name=name  name of the bot

EXAMPLE
  $ botc init --name bot_name
  creating bot.json

botc build

initial scaffolding from bot.json


USAGE
  $ botc build

OPTIONS
  -d, --dialogflow  use dialogflow

EXAMPLE
  $ botc build

botc rebuild

apply changes in bot.json, preserve function implementations in *Impl.js files


USAGE
  $ botc rebuild

EXAMPLE
  $ botc rebuild