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 20+ installed on your system
AWS Credentials
AWS credentials configured for CDK synthesis
30-Second Setup
Navigate to your CDK project
Open your terminal and go to your CDK project directory
cd my-cdk-projectInstall and initialize
Install CDK Insights and add npm scripts to your project
npm install --save-dev cdk-insights && npx cdk-insights initRun your first scan
Use the familiar npm run command to scan your CDK stacks
npm run cdk-insightsReview 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:
What's Next?
Now that you've run your first scan, explore more advanced features and configuration options.