Installation

Install the package

npm install @cloudburn/sdk

The package ships with .d.ts type definitions and supports both ESM and CJS module formats. No additional @types/ package is needed.

TypeScript / ESM note

The SDK is fully typed. If your project uses "type": "module" in package.json, use the ESM build automatically. For CJS projects, the CJS build is resolved automatically by Node's module resolution.

Minimum supported Node version is 24.

AWS credentials

Discovery scans (live AWS scanning) require valid AWS credentials. The SDK uses the AWS SDK v3 default credential chain — no explicit credential configuration in your code is needed.

The credential chain resolves in this order:

1. Environment variables — AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN
2. Shared credentials file — ~/.aws/credentials (profile selected via AWS_PROFILE)
3. SSO credentials — aws sso login
4. IAM instance profile / ECS task role
5. EC2 instance metadata (IMDS)

Region resolves from AWS_REGION > AWS_DEFAULT_REGION > SDK chain.

Static IaC scans do not require AWS credentials.

Smoke test

Verify the installation works:

import { CloudBurnClient } from '@cloudburn/sdk';

const client = new CloudBurnClient();
console.log('CloudBurn SDK loaded');

Run it:

npx tsx smoke-test.ts

You should see CloudBurn SDK loaded with no errors.

What's next