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.
|Command||What it does||Where to run it|
|Create a new project||Anywhere|
|Start Botfront project||from your project folder|
|Stop Botfront project||from your project folder|
|View Botfront logs||from your project folder|
|Watch actions files changes||from your project folder|
You can always get help with
Botfront CLIOptions:-V, --version output the version number-h, --help output usage informationCommands:init [options] Create a new Botfront project.up [options] Start a Botfront project. Must be executed in your project's directorydown [options] Stops a Botfront project and releases Docker resources. Must be executed in your project's directorylogs [options] Display botfront logs. Must be executed in your project's directorykillall [options] Stops any running Botfront projectstop <service> Stop a Botfront service (interactive). Must be executed in your project's directorystart <service> Start a Botfront service (interactive). Must be executed in your project's directoryrestart <service> Restart a Botfront service (interactive). Must be executed in your project's directorywatch Restart the Actions service automatically on file change. Must be executed in your project's directorydocs Open the online documentation in your browserupdate Update a project if the current Botfront version as a higher minor version but not a different major version
The CLI wraps
botfront up generates
.docker-compose.yml at the root of your project and then invokes
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
Sometimes Docker may complain about a missing network or a conflicting name. One of these commands will generally fix the problem:
botfront downfrom your project folder
botfront killallfrom anywhere
docker system prunefrom anywhere