Install

How access to the Klorad packages works, which ones your app needs, and how to install them locally and in CI.

The Klorad SDK is licensed software. The packages are private packages on npm under the @klorad scope, available to developers at organisations that hold a licence agreement with Prieston Technologies: customers, partners, and research groups with research access.

Getting access

Prieston Technologies adds the npm account of each developer covered by your licence to a read only team of the @klorad organisation on npm. Send your contact at Prieston the npm user names of the developers who need access. Nothing else is installed or configured on your side.

Requirements

Node.js 18 or newer
pnpm or npm
an npm account with access, as above

On your machine

npm login
pnpm add @klorad/api @klorad/react @klorad/engine-three three

npm login stores your credentials in your user .npmrc, and pnpm reads them from there too.

In CI

Create a granular access token on npmjs.com with read only access to the @klorad packages, store it as a secret (for example NPM_TOKEN), and add an .npmrc to the project:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

The token stays in the CI secret store; the .npmrc only refers to it.

Which packages you need

Package	You need it when	Peer dependencies
`@klorad/api`	Always. The world model (`/world`) and the integration layer (`/integration`).	none
`@klorad/react`	You build the interface in React.	`react` 18.3 or 19
`@klorad/engine-three`	You draw the scene in 3D. `/react` adds the `ThreeView` component.	`three` 0.170 or newer; `react` and `@klorad/react` for `/react`
`@klorad/access`	More than one kind of user: Worlds, entitlement, audit log.	none
`@klorad/notify`	Alerts from rules over readings and Actions.	none

Each package is ESM only, ships its own type declarations, and has no runtime dependency outside the Klorad packages it names. A renderer is chosen by installing it: an app that does not draw in 3D never downloads three.js.

Licence

The packages are proprietary. You may use them only under your licence agreement with Prieston Technologies and within the scope it grants; the LICENSE file in each package says the same. Builds are minified; the type declarations are complete and readable, and they are what you and your agents code against.