Skip to content

ganesh250684/TerraformReportExtension

Repository files navigation

πŸš€ Terraform Report Generator for VS Code

Stop squinting at Terraform plan output! Transform cryptic terminal text into beautiful, professional PDF reports in seconds.

VS Code Marketplace Installs Rating License: MIT GitHub

😫 The Problem Every Terraform User Faces

You're about to apply a critical infrastructure change...

  • ❌ Staring at 500+ lines of terminal output
  • ❌ Scrolling endlessly to find that one resource change
  • ❌ Your manager asks: "What exactly is changing?" and you scramble to copy-paste text
  • ❌ No clear way to review, share, or archive what's about to happen
  • ❌ Can't easily spot dangerous destroys buried in the noise
  • ❌ Wasting 30+ minutes manually documenting changes for approval

Sound familiar? You're not alone. Every DevOps engineer has been there.

✨ The Solution: One-Click Beautiful Reports

This VS Code extension transforms your Terraform plan chaos into crystal-clear, professional PDF reports that:

  • βœ… Highlight critical changes with color-coded actions (create βž•, modify πŸ”„, destroy ❌)
  • βœ… Organize everything in clean tables and sections
  • βœ… Export instantly to PDF for sharing with stakeholders
  • βœ… Work 100% offline - no external dependencies, no API calls
  • βœ… Save you hours of manual documentation every week

🎯 Why You NEED This Extension

For DevOps Engineers

  • πŸ“‹ Stop manually documenting - Generate change reports in 2 seconds
  • πŸ‘€ Spot dangerous changes instantly - Destroys are highlighted
  • πŸš€ Speed up reviews - Clear, scannable format vs terminal soup
  • πŸ“Š Track history - Archive reports for compliance and audits

For Team Leads

  • πŸ‘₯ Approve changes confidently - See exactly what's changing without Terraform expertise
  • πŸ“ˆ Improve team productivity - Eliminate back-and-forth questions
  • πŸ”’ Reduce risk - Better visibility = fewer production incidents

For Organizations

  • πŸ“ Meet compliance requirements - Documented change records for every deployment
  • πŸ’° Save money - Reduce time spent on change reviews by 80%
  • πŸŽ“ Onboard faster - New team members understand changes easily

πŸš€ Quick Start (30 seconds!)

  1. Install this extension from VS Code Marketplace
  2. Generate a Terraform plan: terraform plan -out=plan.tfplan && terraform show -no-color plan.tfplan > plan.txt
  3. Open plan.txt in VS Code
  4. Right-click β†’ Select Terraform: Generate Plan Report
  5. Done! Your beautiful PDF report is ready πŸŽ‰

πŸ“Έ What You Get

Before: Terminal Chaos

Terraform will perform the following actions:

  # aws_instance.web will be created
  + resource "aws_instance" "web" {
      + ami                          = "ami-0c55b159cbfafe1f0"
      + arn                          = (known after apply)
      + associate_public_ip_address  = (known after apply)
      ...
      [200+ more lines of hard-to-read text]

After: Professional Report

πŸ“Š TERRAFORM PLAN REPORT
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

πŸ“ˆ SUMMARY
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”
β”‚ Resources to Add    β”‚   5   β”‚
β”‚ Resources to Change β”‚   2   β”‚
β”‚ Resources to Destroyβ”‚   0   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”˜

οΏ½ CRITICAL ACTIONS
None - Safe to proceed βœ“

βž• RESOURCES TO CREATE
1. aws_instance.web
   Type: EC2 Instance
   Changes: Initial creation...

πŸ› οΈ Installation

Option 1: From VS Code Marketplace (Recommended)

  1. Open VS Code
  2. Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac)
  3. Search for "Terraform Report Generator"
  4. Click Install
  5. Reload VS Code

Option 2: From VSIX File

code --install-extension terraform-report-generator-1.0.0.vsix

Option 3: Manual Installation

  1. Download .vsix file from GitHub Releases
  2. In VS Code: Extensions β†’ ... menu β†’ Install from VSIX
  3. Select downloaded file

🎬 How to Use

Method 1: Context Menu (Easiest)

  1. Generate your Terraform plan file:
    terraform plan -out=plan.tfplan
    terraform show -no-color plan.tfplan > plan.txt
  2. Right-click on plan.txt in VS Code
  3. Select "Terraform: Generate Plan Report"
  4. Report opens automatically! ✨

Method 2: Command Palette

  1. Open your plan file in VS Code
  2. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  3. Type "Terraform: Generate Plan Report"
  4. Press Enter

Method 3: Keyboard Shortcut

  1. Open plan file
  2. Press Ctrl+Alt+T (Windows/Linux) or Cmd+Alt+T (Mac)
  3. Instant report!

πŸ“š Available Commands

Command Description When to Use
Terraform: Generate Plan Report Auto-detect best mode Default choice - Let the extension decide
Terraform: Generate Basic Report Fast, offline mode Quick reviews, no AI needed
Terraform: Generate AI Report Enhanced analysis Complex changes, need insights

🎨 Report Features

Basic Mode (Lightning Fast ⚑)

Terraform Plan β†’ Parser β†’ Markdown β†’ PDF
                 ↓
            - Extract changes
            - List resources  
            - Show attributes
            - Color-coded actions
            
Result: Clean report in 2 seconds

βœ… Perfect for:

  • Daily routine changes
  • Simple infrastructure updates
  • Quick peer reviews
  • CI/CD pipeline documentation

AI-Enhanced Mode (Coming Soon πŸš€)

Terraform Plan β†’ Parser β†’ AI Analysis β†’ Rich Report β†’ PDF
                          ↓
                    - Impact assessment
                    - Risk classification
                    - Testing recommendations
                    - Rollback procedures
                    
Result: Comprehensive analysis in 30 seconds

βœ… Perfect for:

  • Production deployments
  • Complex multi-resource changes
  • Security-critical updates
  • Stakeholder presentations

βš™οΈ Configuration

Customize the extension to fit your workflow:

{
  // Report generation mode
  "terraformReport.mode": "auto",  // "auto" | "basic" | "ai"
  
  // Default export format
  "terraformReport.defaultExport": "pdf",  // "pdf" | "markdown" | "both"
  
  // Auto-open report after generation
  "terraformReport.openAfterGenerate": true,
  
  // Report template style
  "terraformReport.templateStyle": "professional"  // "professional" | "minimal" | "detailed"
}

Configuration Options Explained

Setting Values Description
mode auto, basic, ai How to generate reports (auto detects complexity)
defaultExport pdf, markdown, both Output format preference
openAfterGenerate true, false Automatically open report when done
templateStyle professional, minimal, detailed Report styling

Access Settings

  1. File β†’ Preferences β†’ Settings (or Ctrl+,)
  2. Search for "Terraform Report"
  3. Adjust settings to your preference

πŸ’° Pricing

πŸŽ‰ 100% FREE Forever!

  • βœ… Unlimited basic reports
  • βœ… PDF and Markdown export
  • βœ… All core features
  • βœ… No credit card required
  • βœ… No usage limits
  • βœ… Open source (MIT License)

No hidden costs. No subscriptions. Completely free.

πŸš€ Future AI Features (Optional - Coming Soon)

When we release AI-enhanced analysis:

  • πŸ†“ 10 AI reports per month (free tier)
  • πŸ’Ž Unlimited AI reports with your own OpenAI API key
  • 🏒 Enterprise options for custom integrations

Current version is 100% free with no limitations!

🎯 Real-World Use Cases

1️⃣ Pre-Deployment Review

# Generate plan and report before applying
terraform plan -out=plan.tfplan
terraform show -no-color plan.tfplan > plan.txt
# Generate report in VS Code
# Review β†’ Approve β†’ Apply
terraform apply plan.tfplan

2️⃣ Change Request Documentation

  • Generate report from your plan
  • Attach PDF to Jira/ServiceNow ticket
  • Stakeholders review without Terraform knowledge
  • Track approved changes for compliance

3️⃣ Team Code Reviews

  • Include report in pull request
  • Reviewers see infrastructure impact immediately
  • Faster approvals, fewer questions
  • Better collaboration

4️⃣ Production Safety Check

  • Quickly scan for destroy operations
  • Verify resource counts match expectations
  • Archive report for post-deployment audit
  • Sleep better at night! 😴

�️ Roadmap - What's Coming Next

Version 1.1 (Next Month)

  • πŸ€– AI-Powered Analysis - Intelligent impact assessment and recommendations
  • πŸ“Š Enhanced PDF Styling - More templates and customization
  • πŸ” Plan Comparison - Compare two plans side-by-side
  • πŸ“ˆ Drift Detection - Highlight unexpected changes

Version 1.2 (Q1 2026)

  • πŸ“‹ Change History - Track and archive all your deployments
  • 🎨 Custom Templates - Create your own report layouts
  • πŸ”— CI/CD Integration - GitHub Actions, GitLab CI, Azure DevOps
  • πŸ“Š Dashboard View - Web-based report viewer

Version 2.0 (Q2 2026)

  • 🧠 Advanced AI Features - Risk scoring, dependency analysis
  • πŸ‘₯ Team Collaboration - Share and comment on reports
  • πŸ“± Mobile App - Review plans on the go
  • πŸ”’ Enterprise Security - SSO, RBAC, audit logs

Want a feature? Request it here!

🀝 Contributing

We welcome contributions from the community! Here's how you can help:

  • πŸ› Report bugs - Found an issue? Let us know!
  • πŸ’‘ Suggest features - Have an idea? We want to hear it!
  • πŸ“ Improve docs - Help make our documentation better
  • πŸ’» Submit PRs - Code contributions are always welcome

See CONTRIBUTING.md for detailed guidelines.

πŸ› Troubleshooting

Report generation fails

Solution: Ensure PowerShell is installed and accessible:

pwsh.exe --version

PDF not generated

Solution: Check that your plan file is valid Terraform output:

terraform show -no-color plan.tfplan > plan.txt

Extension not appearing

Solution: Reload VS Code after installation:

  • Press Ctrl+Shift+P
  • Type "Reload Window"
  • Press Enter

Still having issues? Open an issue with:

  • VS Code version
  • Extension version
  • Error message (if any)
  • Sample plan file (sanitized)

πŸ“œ License

MIT License - see LICENSE file for details.

TL;DR: Free to use, modify, and distribute. No restrictions!

πŸ™ Acknowledgments

  • 🎯 Built for DevOps Engineers who spend too much time reading Terraform output
  • πŸ’‘ Inspired by real pain - We've all been there!
  • 🌟 Powered by the community - Your feedback makes this better
  • ❀️ Open source forever - Because great tools should be free

οΏ½ Support & Community

⭐ Show Your Support

If this extension saves you time, please:

  • ⭐ Star the repo on GitHub
  • ✍️ Write a review on VS Code Marketplace
  • 🐦 Share it with your team and on social media
  • β˜• Buy us a coffee (link coming soon!)

Made with ❀️ for the DevOps community

Stop squinting at terminal output. Start shipping with confidence.

Install Now | View on GitHub | Read the Blog

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published