@botonic/cli

Build Chatbots Using React

• @botonic/cli
• Usage
• Commands

Usage

$ npm install -g @botonic/cli
$ botonic COMMAND
running command...
$ botonic (-v|--version|version)
@botonic/cli/0.25.0 darwin-arm64 node-v21.7.1
$ botonic --help [COMMAND]
USAGE
  $ botonic COMMAND
...

Commands

• botonic deploy [PROVIDER]
• botonic destroy [PROVIDER]
• botonic help [COMMAND]
• botonic login
• botonic logout
• botonic new NAME [PROJECTNAME]
• botonic serve
• botonic test

botonic deploy [PROVIDER]

Deploy Botonic project to cloud provider

USAGE
  $ botonic deploy [PROVIDER]

OPTIONS
  -b, --botName=botName    Name of the bot from Hubtype where you want to deploy
  -c, --command=command    Command to execute from the package "scripts" object
  -e, --email=email        Email from Hubtype Organization
  -p, --password=password  Password from Hubtype Organization

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

  $ botonic deploy aws
  Deploying to AWS...

See code: lib/commands/deploy.js

botonic destroy [PROVIDER]

Destroy Botonic project from cloud provider

USAGE
  $ botonic destroy [PROVIDER]

EXAMPLE
  $ botonic destroy aws
  Destroying AWS stack...

See code: lib/commands/destroy.js

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 login

Log in to Botonic

USAGE
  $ botonic login

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

See code: lib/commands/login.js

botonic logout

Log out of Botonic

USAGE
  $ botonic logout

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

See code: lib/commands/logout.js

botonic new NAME [PROJECTNAME]

Create a new Botonic project

USAGE
  $ botonic new NAME [PROJECTNAME]

ARGUMENTS
  NAME         name of the bot folder
  PROJECTNAME  OPTIONAL name of the bot project

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

See code: lib/commands/new.js

botonic serve

Serve your bot in your localhost

USAGE
  $ botonic serve

OPTIONS
  -p, --preview  Run preview Botonic 1.0 serve.

EXAMPLE
  $ botonic serve
  > Project is running at http://localhost:8080/

See code: lib/commands/serve.js

botonic test

Test your Botonic components

USAGE
  $ botonic test

EXAMPLE
  PASS  tests/app.test.js
    ✓ TEST: hi.js (10ms)
    ✓ TEST: pizza.js (1ms)
    ✓ TEST: sausage.js (1ms)
    ✓ TEST: bacon.js
    ✓ TEST: pasta.js (1ms)
    ✓ TEST: cheese.js (1ms)
    ✓ TEST: tomato.js

  Test Suites: 1 passed, 1 total
  Tests:       7 passed, 7 total
  Snapshots:   0 total
  Time:        1.223s
  Ran all test suites.

See code: lib/commands/test.js