Skip to content

Installation

Requirements

  • Node.js 22 or later (LTS)
  • npm, yarn, or pnpm

Install the SDK

npm install @contio/partner-sdk

yarn add @contio/partner-sdk

pnpm add @contio/partner-sdk

Offline or air-gapped installation?

Download the SDK tarball directly from our Downloads page.

TypeScript Support

The SDK is written in TypeScript and includes full type definitions. No additional @types packages are required.

import { ContioPartnerSDK, Meeting, ActionItem } from '@contio/partner-sdk';

Peer Dependencies

The SDK requires TypeScript 4.5 or later as a peer dependency for type checking:

npm install typescript@^5.0.0 --save-dev

Verify Installation

Create a simple test file to verify the SDK is installed correctly:

// test-sdk.ts
import { ContioPartnerSDK } from '@contio/partner-sdk';

console.log('SDK loaded successfully!');
console.log('Available methods:', Object.keys(ContioPartnerSDK));

Run with:

npx ts-node test-sdk.ts

Next Steps