CLI Reference
The CLI (Command Line Interface) allows you to easily manage your bot from the command line.
You need to have the botpress
package installed globally (npm install -g botpress
) to use these commands.
init
Creates and initializes a new bot. Will prompt the user with questions.
botpress init
Note: Must be run inside an empty directory
start
or s
Starts a bot. This command is only at the root of a valid botpress project.
botpress start
# or
botpress start ../path/to/bot
If botpress is not installed globally on the host, you may run a bot using npm start
:
cd path/to/bot && npm start
install
or i
Install a local or community module. This is the equivalent of running npm install -S botpress-<name>
, but we strongly suggest to use botpress install
instead as we might introduce additional logic (like version checking) at a later stage.
botpress install botpress-messenger
# botpress- is optional:
botpress install messenger
# even shorter:
bp i messenger
# local paths are valid:
bp i ~/Desktop/my-module
uninstall
or u
Uninstalls a local or community module. This is the equivalent of running npm uninstall -S botpress-<name>
botpress uninstall messenger
list
or ls
Lists the botpress modules installed.
botpress list
create
or c
Create and initializes a new module.
botpress create
Note: unlike init
, this command does not run npm install
after initialization, you need to run it yourself.
Note 2: module names must start with botpress-
and this command will enforce this rule. To know more about modules, please read the Modules Section.
--version
or -V
Shows the version of the global installation of Botpress
botpress --version