Skip to content

Installation

Get started with Orchestrix in your project.

Requirements

  • Node.js: 24.x or higher
  • TypeScript: 4.x or higher (optional, but highly recommended)

Install

You can install Orchestrix using your favorite package manager:

bash
npm install @eddiecbrl/orchestrix
bash
pnpm add @eddiecbrl/orchestrix
bash
yarn add @eddiecbrl/orchestrix
bash
bun add @eddiecbrl/orchestrix

Optional Adapters

If you want to use distributed persistence or idempotency, you might need to install additional adapters.

Redis Adapter

bash
npm install redis

DynamoDB Adapter

bash
npm install @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb

Next Steps

Now that you have Orchestrix installed, check out the Quick Start to build your first workflow.

Released under the MIT License.