Skip to main content

Installation

Install the Conviso Node SDK using your preferred package manager.

npm​

npm install @codematic.io/cdp-node

yarn​

yarn add @codematic.io/cdp-node

pnpm​

pnpm add @codematic.io/cdp-node

Package Variants​

This SDK is available in two npm packages:

  • @codematic.io/cdp-node (recommended) - Scoped package for production use
  • cdp-node - Unscoped package for legacy compatibility

Both packages contain identical functionality. Use the scoped version for new projects.

Requirements​

  • Node.js: 14.x or higher
  • TypeScript: 4.x or higher (optional, but recommended)

Verify Installation​

After installation, verify that the package is installed correctly:

npm list @codematic.io/cdp-node

You should see output similar to:

[email protected] /path/to/your-project
└── @codematic.io/[email protected]

TypeScript Configuration​

If you're using TypeScript, make sure your tsconfig.json includes:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true,
    "lib": ["es2020"],
    "target": "es2020"
  }
}

Next Steps​

Now that you have the SDK installed, continue to the Quick Start Guide to start integrating with the Conviso.