Install

The Zeebe Node client is available via npm.

Add to an existing project

npm i zeebe-node

Create a new Node.js project

mkdir myproject
cd myproject
npm init -y
npm i zeebe-node

Make it a TypeScript project

npm i -g typescript
tsc --init

Optional: Zeebe Modeler

The Zeebe Modeler is an Electron app that allows you to create, examine, and inspect BPMN files.

You can download a release of the Zeebe Modeler from GitHub here.

Optional: zbctl

The zbctl binary is a command-line client that you can use to send commands to a Zeebe broker cluster. It is useful for debugging and testing.

To install zbctl:

npm i -g zbctl

After installation, you can run zbctl and see the available options with:

zbctl