Development Setup

Set up your development environment for PraisonAI JavaScript framework

Set up a local PraisonAI TypeScript development environment.

Where the code lives

TypeScript source is in the PraisonAI monorepo at src/praisonai-ts/, while MervinPraison/praisonai-js is a read-only npm mirror updated automatically from the monorepo by the Sync to praisonai-js GitHub Actions workflow.

Open all TypeScript issues and pull requests against MervinPraison/PraisonAI. PRs opened against praisonai-js will be overwritten on the next sync.

Maintainers: run the mirror sync

Run the mirror sync after a TypeScript change merges to main:

gh workflow run "Sync to praisonai-js" --repo MervinPraison/PraisonAI

The workflow rsyncs src/praisonai-ts/ → praisonai-js (excludes node_modules/, dist/, coverage/, .github/). Default mode opens a PR against praisonai-js; mode=commit pushes directly.

Development Setup

Quick Start

1. Simple Usage

   git clone https://github.com/MervinPraison/PraisonAI.git
   cd src/praisonai-ts
   
2. With Configuration

   npm install
   
3. Build Package

   npm run build
   

Issue Routing & npm Mirror

File TypeScript issues on the monorepo, fix them in src/praisonai-ts/, and let maintainers publish the npm mirror.

File every TypeScript SDK bug or feature request on MervinPraison/PraisonAI using the bug or feature template. Do not open TypeScript issues on praisonai-js.

All TypeScript source lives in src/praisonai-ts/ inside the PraisonAI monorepo. Fork the monorepo, branch off main, and open your PR there.

MervinPraison/praisonai-js is a one-way, downstream mirror. It exists so the praisonai npm package can be published from a standalone repo. It is not a fix target — do not open code PRs against it.

After a TypeScript PR merges on the monorepo, a maintainer syncs the mirror:

gh workflow run "Sync to praisonai-js" --repo MervinPraison/PraisonAI

Direction is monorepo → praisonai-js only.

Package Structure

src/
├── agent/         # Agent-related interfaces and implementations
├── task/          # Task management and execution
├── utils/         # Utility functions and helpers
└── types/         # TypeScript type definitions

• Bundles cleanly for non-Node runtimes (Tauri, React Native, browser). See Browser & Mobile Runtimes for runtime-specific patterns.

Related

Contributing

General contribution guide

TypeScript

TypeScript overview

Node.js

Node.js overview

Browser & Mobile

Run in Tauri, React Native, browser, and edge runtimes