Skip to main content
Skip to main content

Quick Start Guide

Get up and running with CDK Insights in under 30 seconds. This guide will help you run your first analysis of your AWS CDK infrastructure.

Prerequisites

CDK Project

An existing AWS CDK project with TypeScript or Python

Node.js

Node.js 18+ installed on your system

AWS Credentials

AWS credentials configured for CDK synthesis

30-Second Setup

1

Navigate to your CDK project

Open your terminal and go to your CDK project directory

cd my-cdk-project
2

Run CDK Insights

Execute CDK Insights to analyze your CDK stacks

npx cdk-insights scan
💡 Alternative: If you have CDK Insights installed globally, you can use cdk-insights scan instead
3

Review the results

CDK Insights will display a table of findings with severity levels

The analysis includes security issues, cost optimizations, and best practices

Example Output

CDK Insights will display a comprehensive table of findings, sorted by severity:

Resource
Stack
Severity
Service
Issue
Location
MyBucket
MyStack
🔴 CRITICAL
S3
S3 bucket has public read access
lib/my-stack.ts:15
MyRole
MyStack
🟠 HIGH
IAM
IAM role has overly permissive policies
lib/my-stack.ts:25
MyFunction
MyStack
🟡 MEDIUM
Lambda
Lambda function has high memory allocation
lib/my-stack.ts:35

What's Next?

Now that you've run your first scan, explore more advanced features and configuration options.

Installation GuideExplore Features