Installation - Parmana

Parmana ships as three consumable surfaces: the Runtime (the monorepo you run yourself), the TypeScript SDK, and the Python SDK. Which one you install depends on what you’re building.

Runtime (monorepo)
TypeScript SDK
Python SDK

Clone the parmana repository and install workspace dependencies. Node.js >=22 is required.

git clone https://github.com/pavancharak/parmana.git
cd parmana
npm install

Build all workspace packages:

npm run build

Run the test suite:

npm test

Start the API server in development mode:

npm run dev

This runs packages/api/src/server.ts, which exposes the REST API described in the API reference.

npm install @parmana/sdk

The SDK source lives at typescript/ in the monorepo and imports models from @parmana/policy and other workspace packages. Confirm the published package name in your package.json / npm registry before pinning a version, since the SDK is under active development.

import { ParmanaClient } from "@parmana/sdk";

const client = new ParmanaClient({
  endpoint: "http://localhost:3000",
  transport: /* default HTTP transport */ undefined,
});

See TypeScript SDK → Installation for full configuration options.

pip install parmana

from parmana import ParmanaClient

client = ParmanaClient(endpoint="http://localhost:3000")

See Python SDK → Installation for full configuration options.

Requirements

Component	Requirement
Runtime (monorepo)	Node.js `>=22`, npm workspaces
TypeScript SDK	Node.js or a modern browser runtime with `fetch`
Python SDK	Python 3.9+

Next step

Continue to the Quickstart to execute your first Business Transaction.

​Requirements

​Next step

Requirements

Next step