Studio CLI

CSML Studio comes with a CLI (command-line interface) tool that helps you develop your chatbot locally before deploying it. With the CSML Studio CLI, you can update your flows using your favorite code editor on your local machine and publish it on CSML Studio. For larger projects, we recommend using the CSML Studio CLI over the online interface as it makes it easier to manage many flows.

Setting up CSML Studio CLI

To setup CSML Studio CLI, simply install the tool with npm install -g @csml/studio-cli (requires nodejs 12+). Then, using your bot's API keys (see the Studio API section to learn more about creating API keys), you can now run csml-studio init -k MYKEY -s MYSECRET -p path/to/project.

This command will setup a local development environment where you will be able to manage your chatbot entirely from the comfort of your machine!

Broadcasting with CSML Studio CLI

Broadcasting to a large number of targets can be done really easily with the CSML Studio CLI tool. Indeed, you simply need to prepare a file with all your targets:

Then, simply run the following command, which will send each of these targets a broadcast (message initiated from the bot) on the configured channel (based on the given API keys):

csml-studio broadcast -i myfile.csv --flow_id myBroadcastFlow -k MYKEY -s MYSECRET

Source code and package repository

Last updated