Introduction

What Klorad is, what you can build with it today, and how these docs are organised.

Klorad is a TypeScript SDK for building digital twins: software models of real places and things that stay in step with them. You describe a scene anchored on Earth, put objects in it, connect the sensors and systems that report on those objects, and decide who may see and act on what. A renderer draws the result; React bindings let you build the interface around it.

What you can build today

With version 0.1 you can:

anchor a scene on a real place and position objects by latitude and longitude or by metres from an origin;
classify every object as a Digital Object, a Digital Shadow (fed by readings) or a Digital Twin (fed by readings and able to receive commands);
connect sources of readings: generated fixtures, any API you can poll, and simulated devices that accept commands;
order readings by when they were observed, so late and duplicate data never corrupt the current state, and tell when a sensor has gone quiet;
define Actions that only entitled people can take, the Behaviours that follow and the Animations that show them;
give each team a World: a view of the twin that contains only the objects and Actions that team is entitled to, with every Action written to an audit log;
raise alerts from rules over the scene's events;
draw all of it with three.js, in plain TypeScript or as a React component.

The sandbox runs each of these live.

Not yet

A realtime transport between browsers, connectors for named vendors and renderers beyond three.js are on the roadmap, not in 0.1. These pages describe only what the packages do today.

How these docs are organised

Get started

Install the packages and build a working twin, step by step.

Concepts

The model behind the API, one idea per page. Read these to understand why.

Guides

Short recipes for one task each: connect an API, add an Action, give a team a World.

Reference

Every package and export: what it takes, what it returns, what it guarantees.

If you are new, follow the quickstart first, then read the model. If you already know what you want to do, go to the guide for it.

Who it is for

Developers at organisations that build or run digital twins with Klorad: Prieston's customers and partners, and research groups with research access. The SDK is licensed software; Install explains how access works. You need to know TypeScript; React is optional. The docs are written for you and for the AI agents you work with.