Client library and CLI for building BIM apps and cloud components on That Open Platform. Apps run inside the platform's browser environment; cloud components run server-side and can be triggered from any app.
npm install -g @thatopen/services@latest| Type | Template | Use when |
|---|---|---|
| App | app |
You're building a BIM app that runs in the platform's browser UI |
| Cloud component | cloud-component |
You're building server-side logic triggered by an app |
See the full command reference here:
→ docs/cli/create.md
To use beta engine libraries instead of the stable ones, see:
→ docs/cli/swap.md
Once scaffolded, open AGENTS.md in the scaffolded project root — it has everything needed to start building.
Founding Members get early access to the private beta engine libraries (@thatopen-platform/*-beta). The CLI configures access automatically — no npm account or manual token needed.
thatopen login --token <your-token> # API token from the dashboard → Data → API Tokens
thatopen create my-app --beta # new project on the beta libraries
# or, in an existing project:
thatopen swap --beta # toggle the current project to betaOn --beta, the CLI fetches your read-only beta npm credentials and writes them to the project's .npmrc, so npm install resolves the private packages. The .npmrc is gitignored — it carries a credential, so don't commit or share it. Access is tied to your membership; non-Founding accounts get a clear message and the project is still created.
- Library —
EngineServicesClientandPlatformClientfor interacting with the That Open API (files, folders, apps, cloud components, executions, permissions). - CLI —
thatopencommand for scaffolding and publishing. - Built-in component types — TypeScript stubs for platform-hosted components.
Full reference for all CLI commands and flags:
→ docs/cli/paths.json
See CONTRIBUTING.md for setup, build commands, and publishing workflow.