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.

Supported sources include environment credentials, AWS IAM Identity Center sessions, shared AWS profiles, web identity, process credentials, ECS task credentials, and EC2 instance profiles. The AWS SDK controls their precedence; see AWS credential providers.

CloudBurn resolves the current region from AWS_REGION, then AWS_DEFAULT_REGION, then aws_region, and finally the AWS SDK region provider, including the selected profile's shared configuration.

Every discovery method also accepts explicit credentials through options.aws.credentials, which overrides the ambient chain for that call. See AWS Credentials.

Static IaC scans do not require AWS credentials. The AWS clients and credential providers load lazily on the first discovery call, so importing the package and running scanStatic() work without any AWS setup.

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