Installation

Prerequisites

• Node.js 22 (same major as the ComeBk web applications)
• Access credentials for your organisation’s ComeBk environment
• Network reachability to ComeBk API endpoints published for your tenant

Exact package names and registry URLs are issued with environment access. This guide describes the install shape, not a public npm publish path.

Install the application package

npm install @comebk/sdk

Pin the major version that matches your tenant’s API release. Confirm compatibility in the Release notes for that version.

Configure environment

Create a local environment file (never commit secrets):

COMEBK_API_BASE_URL=https://api.example.com/v1
COMEBK_TENANT_ID=your-tenant-id
COMEBK_API_TOKEN=your-token

| Variable | Purpose | | --------------------- | -------------------------------- | | COMEBK_API_BASE_URL | Tenant API base URL | | COMEBK_TENANT_ID | Tenant identifier | | COMEBK_API_TOKEN | Machine or personal access token |

Verify connectivity

npx comebk whoami

A successful call returns tenant id, environment name, and token scope. Failures usually indicate wrong base URL, expired token, or missing network allowlisting.

Next steps

• Quick start — create a sample opportunity cycle
• Core concepts — vocabulary used across ComeBk
• Deployment checklist — production readiness items

Questions that are not installation-specific: FAQ or Contact.