Installation

Quickly start using Harmonix right from your terminal.

---

New Project

Required Tools:

• Node.js - v18.0.0 or newer
• Text editor - Use your favorite text editor to write code (e.g. Visual Studio Code)
• Terminal - Use your terminal to run commands

To initiate a new starter project, open your terminal and execute the following command:

npx

npx @harmonix-js/cli init bot-name

pnpm

pnpm dlx @harmonix-js/cli init bot-name

yarn

yarn dlx @harmonix-js/cli init bot-name

Open your project directory in your text editor (e.g. Visual Studio Code):

code <project-name>

Or navigate to the project directory:

cd <project-name>

Start the Bot

Now you'll be able to start your bot by running:

npm

npm run start

pnpm

pnpm start

yarn

yarn start

An error will occur. Refer to the Configuration guide to learn how to set up your bot.