Skip to content

Getting Started

Installation

Prerequisites and steps to install a Catoids environment for development or evaluation.

  • Getting Started
  • 1 min read

Prerequisites

  • Node.js 22.x for local tooling and SDKs
  • Access credentials for a Catoids evaluation or development tenant
  • Network access to the platform API endpoint assigned to your tenant

Install the application package

Install the Catoids SDK package used by application and kernel projects:

npm install @catoids/sdk

Pin a minor version that matches your tenant release (see Release notes).

Configure environment

Set tenant, endpoint, and credential variables. Exact names depend on your deployment; a minimal local example:

export CATOIDS_API_BASE=https://api.example.catoids.local/v1
export CATOIDS_TENANT_ID=your-tenant
export CATOIDS_TOKEN=your-bearer-token

Do not commit tokens. Prefer secret managers or local env files excluded from version control.

Verify connectivity

Call the authentication or health endpoint documented in the API overview. A successful response confirms tenant resolution and credential scope.

Next steps