Getting Started

The shortest path from clone to a running chat.

git clone https://github.com/MervinPraison/PraisonAI
cd PraisonAI/src/praisonai-mobile
npm install && npm run check

Quick Start

Install

cd PraisonAI/src/praisonai-mobile
npm install

The package is private and needs Node >=22.18. Runtime dependencies load through adapters, so there is no runtime dependencies block.

Run the gates

npm run typecheck
npm run test
npm run check

check chains typecheck, boundaries, and test.

Build the webview bundle

npm run build

Package Scripts

Every script the package ships, from package.json.

Script	What it does
`typecheck`	`tsc -p tsconfig.json`.
`test`	Runs the `node --test` suite across every layer.
`boundaries`	Fails the build if an import crosses a seam.
`build`	Builds the webview bundle.
`test:bundle`	Runs the bundle-gate’s own suite.
`check`	`typecheck` + `boundaries` + `test`.
`check:upstream`	Checks the real `Agent` still satisfies the port.
`build:webview`	Same as `build`.

Swap the Engine

Which engine answers is a setting, read at boot in app/src/main.ts. Change one value.

const booted = await createApp({
  storage: platform.storage,
  secrets: platform.secrets,
  time: platform.time,
  shell: platform.shell,
  engines: enginesFor({ settings, http: platform.http }),
  settingDefs: SETTING_DEFS,
  engineId: "remote-http",
  onPublish: publish,
  now: () => Date.now(),
  newChatId: () => globalThis.crypto.randomUUID(),
});

Set engineId: "praisonai-ts" to run the agent loop in-process instead of over HTTP. The in-process engine is offered only when its factory is passed to enginesFor.

The device build is blocked on PraisonAI PR #4438: crypto and events are static imports on the Agent graph and die at webview import time. The app runs today with remote-http; it becomes runnable on device with praisonai-ts once #4438 lands.

Best Practices

Run npm run check before every commit

The bundle gate catches Node builtins and top-level process.env that pass in Node but blank the webview on device.

Start with remote-http

It speaks the full 11-event vocabulary against a running desktop engine, so you see tool rows and approvals while iterating.

Keep the engine choice in settings

engineId is read from settings at boot, so users switch runtimes without a rebuild.

Agent Engine Port

The three shipped engines and the conformance harness.

The Two Seams

Why the boundaries are enforced by build.

Install

Core Concepts

Guides

Features

Models

Databases

Observability

Memory

Telemetry & Analytics

Knowledge

RAG

Persistence

Tools

Other Features

Developers

Configuration

Best Practices

Getting Started (No Code)

Getting Started

Quick Start

Package Scripts

Swap the Engine

Best Practices

Agent Engine Port

The Two Seams

​Quick Start

​Package Scripts

​Swap the Engine

​Best Practices

​Related

Agent Engine Port

The Two Seams

Quick Start

Package Scripts

Swap the Engine

Best Practices

Related