# Symphony Messaging Generator

{% hint style="info" %}
**Prerequisite**: Install NodeJS first, either [directly](https://nodejs.org/en) or via [nvm](https://github.com/nvm-sh/nvm). You can also use other package managers like [bun](https://bun.sh) or [yarn](https://yarnpkg.com), which the generator will attempt to use before falling back to npm.
{% endhint %}

The Symphony Generator is a yeoman-based CLI tool that can be used to quickly generate Symphony Messaging bot, app and workflow project scaffolds. You can create example projects that use our developer toolkits:

* BDK for Java
* BDK for Python
* WDK
* ADK

## Quick Start

Install yeoman and the Symphony Messaging Generator.

{% tabs %}
{% tab title="npm" %}

```bash
$ npm i -g yo @finos/generator-symphony
```

{% endtab %}

{% tab title="yarn" %}

```bash
$ yarn global add yo @finos/generator-symphony
```

{% endtab %}

{% tab title="bun" %}

```bash
$ bun add -g yo @finos/generator-symphony
```

{% endtab %}
{% endtabs %}

Then, create a directory for your new project and launch the generator.

```bash
$ mkdir mybot && cd $_
$ yo @finos/symphony
```

Configure your bot, workflow or app environments accordingly.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.developers.symphony.com/dev-tools/generator.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
