Quickstart

This is the shortest path from zero to a local Cumulocity microservice.

Before You Start

• Use Node.js 24 or newer.
• Use a Node Nitro preset such as node-server or node-cluster.
• Have access to a Cumulocity tenant for development.

Create a Service

Use the starter template:

pnpm dlx giget@latest gh:schplitt/c8y-nitro-starter my-microservice
cd my-microservice
pnpm install

Or install into an existing Nitro service:

pnpm add c8y-nitro nitro@latest

Enable the Module

import c8y from 'c8y-nitro'

export default defineNitroConfig({
  preset: 'node-server',
  builder: 'rolldown',
  modules: [c8y()],
})

Add Development Tenant Credentials

Create .env or .env.local:

C8Y_BASEURL=https://your-tenant.cumulocity.com
C8Y_DEVELOPMENT_TENANT=t12345
C8Y_DEVELOPMENT_USER=your-username
C8Y_DEVELOPMENT_PASSWORD=your-password

Start Developing

pnpm dev

On the first run, c8y-nitro checks the development tenant, creates or reuses the microservice, subscribes the tenant, and writes bootstrap credentials back into the env file.

Next Steps

• Read Configuration to shape module behavior.
• Read Auto-Bootstrap to understand development tenant setup.
• Read Utilities when writing tenant-aware runtime code.