Botfront.
 Github
Authoring conversations
Configuring channels
On screen guidance
Proactive conversations
Installation
On your local machineOn servers or clustersUsing the CLIMain commandsOther commandsUsing plain docker-compose commandsTroubleshootingMigration guide
Developers
Administration

Using the Botfront CLI

Botfront comes with a command line interface (CLI) to manage your projects. The CLI is useful to scaffold projects and launch all required services (Botfront, Rasa, Duckling, MongoDB,…).

You can start the CLI by running botfront in your terminal. It will open a contextual menu which contains the options you would need most of the time.

Note that You can use the CLI when Botfront is installed on your local machine or on a single server, but not on a cluster.

Main commands

CommandWhat it doesWhere to run it
botfront initCreate a new projectAnywhere
botfront upStart Botfront projectfrom your project folder
botfront downStop Botfront projectfrom your project folder
botfront logsView Botfront logsfrom your project folder
botfront watchWatch actions files changesfrom your project folder

Other commands

You can always get help with botfront --help

Botfront CLI
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
init [options] Create a new Botfront project.
up [options] Start a Botfront project. Must be executed in your project's directory
down [options] Stops a Botfront project and releases Docker resources. Must be executed in your project's directory
logs [options] Display botfront logs. Must be executed in your project's directory
killall [options] Stops any running Botfront project
stop <service> Stop a Botfront service (interactive). Must be executed in your project's directory
start <service> Start a Botfront service (interactive). Must be executed in your project's directory
restart <service> Restart a Botfront service (interactive). Must be executed in your project's directory
watch Restart the Actions service automatically on file change. Must be executed in your project's directory
docs Open the online documentation in your browser
update Update a project if the current Botfront version as a higher minor version but not a different major version

Using plain docker-compose commands

The CLI wraps docker-compose. botfront up generates .env and .docker-compose.yml at the root of your project and then invokes docker-compose up. Once those files are generated you can use all docker-compose commands from the root of your project. Note that since those files are generated, any change will be overwritten next time you run botfront up. Instead, make changes to the files found in the .botfront folder.

Troubleshooting

Sometimes Docker may complain about a missing network or a conflicting name. One of these commands will generally fix the problem:

  • botfront down from your project folder
  • botfront killall from anywhere
  • docker system prune from anywhere