cdk-insights 0.2.0-beta.2 → 0.2.0-beta.4

package/README.md

@@ -23,12 +23,12 @@ CDK Insights helps you identify security vulnerabilities, cost optimization oppo
 
 ```bash
 # Run immediately without installing anything
-npx cdk-insights analyze
+npx cdk-insights scan
 ```
 
 That's it! CDK Insights will:
 
-1. Analyze your CDK stacks
+1. Scan your CDK stacks
 2. Show you issues it found
 3. Provide recommendations to fix them
 
@@ -46,13 +46,41 @@ npm install --save-dev cdk-insights
 ```json
 {
   "scripts": {
-    "analyze": "cdk-insights analyze",
-    "analyze:all": "cdk-insights analyze --all",
-    "analyze:security": "cdk-insights analyze --services IAM,S3,Lambda"
+    "cdk-insights": "node scripts/cdk-insights-wrapper.js"
   }
 }
 ```
 
+**Using NPM Scripts (Recommended):**
+
+After installing, you can use convenient npm scripts:
+
+```bash
+# Basic scan
+npm run scan
+
+# Scan all stacks
+npm run scan:all
+
+# Different output formats
+npm run scan:json
+npm run scan:markdown
+npm run scan:summary
+
+# Setup CDK Nag integration
+npm run cdk-insights -- setup-cdk-nag
+
+# Install Git pre-commit hooks
+npm run cdk-insights -- hook
+
+# Cache management
+npm run cdk-insights -- cache-status
+npm run cdk-insights -- cache:clear
+
+# Configuration
+npm run cdk-insights -- config list
+```
+
 **For Personal Use:**
 
 ```bash
@@ -60,7 +88,7 @@ npm install --save-dev cdk-insights
 npm install -g cdk-insights
 
 # Use from anywhere
-cdk-insights analyze
+cdk-insights scan
 ```
 
 ## 📖 How to Use CDK Insights
@@ -68,14 +96,14 @@ cdk-insights analyze
 ### Basic Commands
 
 ```bash
-# Analyze a specific stack
-cdk-insights analyze MyStack
+# Scan a specific stack
+cdk-insights scan MyStack
 
-# Analyze all stacks in your project
-cdk-insights analyze --all
+# Scan all stacks in your project
+cdk-insights scan --all
 
 # Interactive mode (recommended for first time)
-cdk-insights analyze
+cdk-insights scan
 ```
 
 ### What You'll See
@@ -104,19 +132,19 @@ Choose how you want to see your results:
 
 ```bash
 # Table format (default) - great for quick review
-cdk-insights analyze --output table
+cdk-insights scan --output table
 
 # Markdown format - perfect for GitHub issues and PRs
-cdk-insights analyze --output markdown
+cdk-insights scan --output markdown
 
 # JSON format - ideal for CI/CD pipelines
-cdk-insights analyze --output json
+cdk-insights scan --output json
 
 # Summary format - just the essentials
-cdk-insights analyze --output summary
+cdk-insights scan --output summary
 ```
 
-## 🔍 What Gets Analyzed
+## 🔍 What Gets Scanned
 
 CDK Insights checks your infrastructure across these AWS services:
 
@@ -143,28 +171,28 @@ CDK Insights checks your infrastructure across these AWS services:
 
 ```bash
 # Focus on security issues
-cdk-insights analyze --services IAM,S3,KMS,SecretsManager
+cdk-insights scan --services IAM,S3,KMS,SecretsManager
 ```
 
 ### Cost Optimization
 
 ```bash
 # Find cost savings opportunities
-cdk-insights analyze --services EC2,DynamoDB,RDS,EBS
+cdk-insights scan --services EC2,DynamoDB,RDS,EBS
 ```
 
 ### Before Deployments
 
 ```bash
-# Full analysis before going to production
-cdk-insights analyze --all --output markdown
+# Full scan before going to production
+cdk-insights scan --all --output markdown
 ```
 
 ### In Your CI/CD Pipeline
 
 ```bash
 # Automated checks in your deployment process
-cdk-insights analyze --output json | jq '.summary.totalIssues'
+cdk-insights scan --output json | jq '.summary.totalIssues'
 ```
 
 ## ⚙️ Configuration
@@ -175,7 +203,7 @@ Set your preferences once and CDK Insights will remember them:
 # Set your preferred output format
 cdk-insights config set output markdown
 
-# Set default services to analyze
+# Set default services to scan
 cdk-insights config set services IAM,S3,Lambda
 
 # View your current settings
@@ -208,19 +236,19 @@ CDK Insights offers three flexible tiers to meet your needs:
 
 **Core Features**:
 
-- ✅ Basic static analysis (5 analyses/month)
-- ✅ Multi-stack analysis (10 stacks/month)
+- ✅ Basic static scanning (5 scans/month)
+- ✅ Multi-stack scanning (10 stacks/month)
 - ✅ Table, JSON, and Markdown output formats
 - ✅ CLI tool access
-- ✅ Local analysis
+- ✅ Local scanning
 - ✅ Community support
 - ✅ Basic security checks
 - ✅ Basic reporting
 
 **Limits**:
 
-- 5 basic analyses per month
-- 10 multi-stack analyses per month
+- 5 basic scans per month
+- 10 multi-stack scans per month
 - 1 team member
 - 5 project fingerprints
 
@@ -234,7 +262,7 @@ CDK Insights offers three flexible tiers to meet your needs:
 
 **Everything in Free, plus**:
 
-- ✅ **Unlimited** basic and multi-stack analysis
+- ✅ **Unlimited** basic and multi-stack scanning
 - ✅ AI-powered recommendations (100/month)
 - ✅ Contextual fix suggestions (100/month)
 - ✅ Smart prioritization
@@ -245,9 +273,9 @@ CDK Insights offers three flexible tiers to meet your needs:
 - ✅ GitHub integration (100 integrations/month)
 - ✅ Team dashboards
 - ✅ Shared configurations (10 configs)
-- ✅ Cloud-based analysis
-- ✅ Parallel analysis
-- ✅ Caching & incremental analysis
+- ✅ Cloud-based scanning
+- ✅ Parallel scanning
+- ✅ Caching & incremental scanning
 - ✅ Large project support (1000+ resources)
 - ✅ Email support
 - ✅ SOC2 & HIPAA compliance
@@ -275,7 +303,7 @@ CDK Insights offers three flexible tiers to meet your needs:
 **Everything in Pro, plus**:
 
 - ✅ **Unlimited** AI recommendations and contextual fixes
-- ✅ Historical trend analysis
+- ✅ Historical trend scanning
 - ✅ Dependency mapping
 - ✅ Custom AI training
 - ✅ Executive summaries
@@ -326,7 +354,7 @@ CDK Insights offers three flexible tiers to meet your needs:
 
 | Feature Category  | Free      | Pro        | Enterprise |
 | ----------------- | --------- | ---------- | ---------- |
-| **Analysis**      | 5/month   | Unlimited  | Unlimited  |
+| **Scanning**      | 5/month   | Unlimited  | Unlimited  |
 | **AI Features**   | ❌        | 100/month  | Unlimited  |
 | **Team Features** | 1 user    | 5 users    | Unlimited  |
 | **Integrations**  | Basic     | GitHub     | All        |
@@ -343,10 +371,10 @@ Create GitHub issues directly from your findings:
 
 ```bash
 # Create issues for all findings
-cdk-insights analyze --with-issue
+cdk-insights scan --with-issue
 
 # Create issues for critical findings only
-cdk-insights analyze --with-issue --rule-filter Security
+cdk-insights scan --with-issue --rule-filter Security
 ```
 
 ## 📊 Understanding Your Results
@@ -378,9 +406,9 @@ cdk-insights analyze --with-issue --rule-filter Security
 - Ensure you have read access to your CDK project files
 - Check that your AWS credentials are configured
 
-**"Analysis is slow"**
+**"Scan is slow"**
 
-- Use `--services` to limit what gets analyzed
+- Use `--services` to limit what gets scanned
 - Try `--output summary` for faster results
 
 ### Getting Help
@@ -395,4 +423,4 @@ CDK Insights is licensed under the MIT License. Some functionality integrates wi
 
 ---
 
-**Ready to improve your CDK infrastructure?** Start with `npx cdk-insights analyze` and discover what insights await! 🚀
+**Ready to improve your CDK infrastructure?** Start with `npx cdk-insights scan` and discover what insights await! 🚀

package/dist/cli/entry.js

@@ -90588,8 +90588,8 @@ async function runStackAnalysis(finalConfig, fingerprint, authToken, licenseInfo
   await runAnalysis(analysisConfig);
 }
 var analyzeCommand = {
-  command: "analyze [stackName]",
-  describe: "Analyze CDK stacks for best practices and security issues",
+  command: "scan [stackName]",
+  describe: "Scan CDK stacks for best practices and security issues",
   builder: (yargs) => yargs.positional("stackName", {
     type: "string",
     describe: "Name of the stack to analyze"
@@ -90970,7 +90970,7 @@ var createHelpTable = () => {
     colWidths: [30, 80]
   });
   helpTable.push(
-    ["analyze", "Run static analysis on a CDK stack"],
+    ["scan", "Scan CDK stacks for best practices and security issues"],
     ["synth", "Run `cdk synth` automatically before analysis"],
     ["hook", "Install Git pre-commit hook for CDK Insights"],
     ["reset", "Clear saved prompt answers and CLI preferences"],
@@ -90978,8 +90978,8 @@ var createHelpTable = () => {
     ["cache-status", "Show cache status and statistics"],
     ["setup-cdk-nag", "Interactive setup to add cdk-nag to your CDK project"],
     ["--output", "Specify output format (json, markdown, table)"],
-    ["--all", "Analyze all stacks"],
-    ["--services", "Comma-separated list of AWS services to analyze"],
+    ["--all", "Scan all stacks"],
+    ["--services", "Comma-separated list of AWS services to scan"],
     ["--with-issue", "Create GitHub issues for findings"],
     ["--summary-only", "Only show summary in console"],
     ["--redact", "Redact sensitive resource names in output"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cdk-insights",
-  "version": "0.2.0-beta.2",
+  "version": "0.2.0-beta.4",
   "description": "AWS CDK security and cost analysis tool with AI-powered insights",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,7 +53,16 @@
     "publish:latest": "npm run build && npm publish --tag latest",
     "version:beta": "npm version prerelease --preid=beta",
     "version:alpha": "npm version prerelease --preid=alpha",
-    "version:rc": "npm version prerelease --preid=rc"
+    "version:rc": "npm version prerelease --preid=rc",
+    "cdk-insights": "node scripts/cdk-insights-wrapper.js",
+    "scan": "node scripts/cdk-insights-wrapper.js scan",
+    "scan:all": "node scripts/cdk-insights-wrapper.js scan --all",
+    "scan:json": "node scripts/cdk-insights-wrapper.js scan --format json",
+    "scan:markdown": "node scripts/cdk-insights-wrapper.js scan --format markdown",
+    "scan:summary": "node scripts/cdk-insights-wrapper.js scan --format summary",
+    "scan:with-issues": "node scripts/cdk-insights-wrapper.js scan --withIssue",
+    "cache:clear": "node scripts/cdk-insights-wrapper.js cache clear",
+    "cache:status": "node scripts/cdk-insights-wrapper.js cache status"
   },
   "publishConfig": {
     "access": "public"