Skip to main content

Installation

Get Parallax up and running in your project.

Prerequisites​

  • Node.js 18+ (for TypeScript SDK)
  • Docker (optional, for containerized deployment)

Install the SDK​

npm install @parallax/sdk-typescript

Or with other package managers:

# yarn
yarn add @parallax/sdk-typescript

# pnpm
pnpm add @parallax/sdk-typescript

Start the Control Plane​

The control plane is the orchestration server that coordinates agents and executes patterns.

docker run -p 8080:8080 parallax/control-plane:latest

Option 2: From Source​

git clone https://github.com/parallax-ai/parallax.git
cd parallax
pnpm install
pnpm --filter @parallax/control-plane dev

Verify Installation​

Check that the control plane is running:

curl http://localhost:8080/health

You should see:

{
  "status": "healthy",
  "version": "1.0.0"
}

Next Steps​