Skip to content

Installation

SDK Package#

Install the @cognest/sdk package to use Cognest programmatically in your application.

terminal
npm install @cognest/sdk

CLI Tool#

The CLI provides commands for project scaffolding, integration management, deployment, and debugging.

terminal
npm install -g @cognest/cli

Integration Packages#

Each integration is a separate package. Install only the ones you need:

terminal
# Install individual integrations
pnpm add @cognest/integration-whatsapp
pnpm add @cognest/integration-slack
pnpm add @cognest/integration-gmail

# Or install all integrations at once
pnpm add @cognest/integrations

Requirements#

RequirementVersion
Node.js18.0 or higher
TypeScript5.0+ (recommended, not required)
Package Managernpm, pnpm, or yarn

TypeScript Setup#

The SDK is written in TypeScript and ships with full type definitions. No additional @types packages are needed.

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Verify Installation#

terminal
# Check CLI version
cognest --version
# → @cognest/cli v2.4.1

# Check SDK version in your project
node -e "console.log(require('@cognest/sdk/package.json').version)"
# → 2.4.1