Using the Symphony Bot Generator

The Symphony bot generator is a yeoman generator that can generate bot projects in various languages as a starting point for development. To use the Symphony bot generator, you'll first need to download and install NodeJS.

Once NodeJS (that includes npm) is installed, execute the following command to install the Yeoman Generator and the Symphony Bot Generator.

npm i -g yo generator-symphony

Once the generators are installed, the yo command line will be available for use globally in your command shell and you can create a new bot project by typing yo symphony.

yo symphony

The Symphony bot generator displays a series of questions allowing you to specify how the bot client is generated. The following shows example screen output when generating a project using our Java SDK.

/------------------------------------------/
/        SYMPHONY GENERATOR  1.0.13         /
/    by [email protected]     /
/ (c) 2019 Symphony Communication Services /
/------------------------------------------/
? What do you want to create bot
? What is the name of your project my-bot-project
? What is your POD subdomain develop2
? What is your preferred programming language Java
? What is the BOT username my-bot-username
? What is the BOT email address [email protected]
? What is your preferred encryption technology RSA - Generate New Keys
? Which template do you want to start with Request/Reply
* Generating bot Java code from Request/Reply template...
Looking for latest version of Java client library..
Latest version of Java client library is 1.0.43
generating from template Request/Reply
* Generating RSA public/private keys for BOT my-bot-username...
* BOT generated successfully!!
   create pom.xml
   create src/main/java/IMListenerImpl.java
   create src/main/java/RequestReplyBot.java
   create src/main/java/RoomListenerImpl.java
   create src/main/resources/config.json
   create certificates/all_symphony_certs_truststore

Updated 9 months ago


What's Next

The Symphony bot generator creates projects that are based on the Symphony API clients. Continue to learn more about the Symphony API clients.

Symphony API Clients

Using the Symphony Bot Generator


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.