Skip to main content

AI-powered Terraform plan reviewer — verify your plan matches your intent before apply

Project description

tfrev — AI-Powered Terraform Plan Reviewer

Verify your Terraform plan matches your code intent before apply.

tfrev uses Claude AI to review your terraform plan output against your code changes, catching mismatches, security risks, and unexpected side effects before they hit production. Works with any Terraform provider — AWS, Azure, GCP, Kubernetes, and more.

Quick Start

Anthropic API (default)

# Install
pip install tfrev

# Set your API key
export ANTHROPIC_API_KEY=sk-ant-...

# Review a plan
terraform plan -out=tfplan
terraform show -json tfplan > plan.json

tfrev review --plan plan.json

AWS Bedrock

# Install with Bedrock support
pip install 'tfrev[aws]'

# Configure AWS credentials (env vars, ~/.aws/credentials, or IAM role)
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export AWS_DEFAULT_REGION=us-east-1

# Via .tfrev.yaml
cat >> .tfrev.yaml <<'EOF'
provider: aws-bedrock
model: anthropic.claude-sonnet-4-5-20250514-v1:0
EOF
tfrev review --plan plan.json

# Or entirely via CLI flags
tfrev review --plan plan.json \
  --provider aws-bedrock \
  --model anthropic.claude-sonnet-4-5-20250514-v1:0

Or use auto-detection:

terraform plan -out=tfplan
tfrev review --auto

To diff against a specific ref (e.g. last deployed SHA):

tfrev review --plan plan.json --base-ref abc1234

To include additional file types in the diff (e.g. Helm values.yaml files or JSON variable files) alongside the default *.tf / *.tfvars:

tfrev review --plan plan.json --diff-pattern '*.yaml' --diff-pattern '*.yml'

The defaults are always retained — --diff-pattern is strictly additive.

What It Catches

  • Intent mismatches — plan does something the code change didn't intend
  • Unexpected replacements — a tag change triggering a full resource destroy+create
  • Security regressions — widened security groups, broadened IAM policies
  • Blast radius — too many resources changing at once
  • Drift — plan changes with no corresponding code change
  • Policy violations — custom team rules defined in .tfrev.yaml

CI/CD Integration

GitHub Actions

# Anthropic API
- name: AI Plan Review
  uses: bishalOps/tfrev@v1
  with:
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    post_comment: "true"
    fail_on: high
# AWS Bedrock (using OIDC or IAM credentials already configured in the job)
- name: AI Plan Review (Bedrock)
  run: |
    pip install 'tfrev[aws]'
    tfrev review --auto --provider aws-bedrock \
      --model anthropic.claude-sonnet-4-5-20250514-v1:0 \
      --output markdown --fail-on high --quiet
  env:
    AWS_DEFAULT_REGION: us-east-1

GitLab CI

include:
  - remote: 'https://raw.githubusercontent.com/bishalOps/tfrev/main/ci/gitlab/.gitlab-ci-template.yml'

Jenkins

Copy ci/jenkins/Jenkinsfile into your repo and add ANTHROPIC_API_KEY as a credential.

Any CI/CD

# Anthropic API
pip install tfrev
export ANTHROPIC_API_KEY=$YOUR_SECRET
tfrev review --auto --output markdown --fail-on high --quiet

# AWS Bedrock (credentials via env or IAM role)
pip install 'tfrev[aws]'
tfrev review --auto --provider aws-bedrock \
  --model anthropic.claude-sonnet-4-5-20250514-v1:0 \
  --output markdown --fail-on high --quiet

Note: Always pass --quiet in CI/CD. Without it, tfrev prompts for interactive confirmation before sending the plan + diff to Claude and will hang waiting for input on a non-interactive stdin. --quiet also suppresses the --base-ref confirmation and the context-overflow prompt.

Configuration

Create a .tfrev.yaml in your project root:

# Provider: "anthropic" (default) or "aws-bedrock"
provider: anthropic

model: claude-sonnet-4-6
fail_on: high
policies:
  - name: no-public-ingress
    description: "Flag security group rules allowing 0.0.0.0/0"
    severity: critical
sensitive_resources:
  - aws_iam_*            # AWS
  - google_project_iam_* # GCP
  - azurerm_key_vault*   # Azure

# Extra file types to include in the diff (additive to *.tf and *.tfvars).
# Useful when your Terraform modules consume Helm values files, JSON configs, etc.
diff_patterns:
  - "*.yaml"
  - "*.yml"

For AWS Bedrock, set provider: aws-bedrock, install tfrev[aws], and use a Bedrock model ID. Region and credentials are read from the standard AWS credential chain (AWS_DEFAULT_REGION, ~/.aws/config, IAM role, etc.):

provider: aws-bedrock
model: anthropic.claude-sonnet-4-5-20250514-v1:0

See .tfrev.yaml.example for all options.

Sample Output

────────────────────────────────────────────────────────────────────────
  ❌  Verdict: FAIL   Confidence: 95%
────────────────────────────────────────────────────────────────────────

  This plan contains three significant security regressions introduced by the code diff:
  SSH access widened from a private CIDR to 0.0.0.0/0, an RDS database marked
  publicly_accessible=true, and an S3 bucket ACL changed from private to public-read. All
  four resource creations are explained by code changes, but the security posture of the
  planned infrastructure is critically degraded and should not be applied without
  deliberate review and approval.

  Resources: 4 reviewed  |  +4 create  |  ~0 update  |  -0 delete  |  -/+0 replace

  ID     Severity     Category             Resource                                   Title
  ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
  F001   CRITICAL     security             aws_security_group.web_sg                  SSH ingress opened to the entire internet (0.0.0.0/0)
  F002   CRITICAL     security             aws_db_instance.app_db                     RDS database instance set to publicly_accessible=true
  F003   HIGH         security             aws_s3_bucket.app_assets                   S3 bucket ACL changed from private to public-read
  F004   MEDIUM       best_practice        aws_db_instance.app_db                     deletion_protection is false on the database resource
  F005   MEDIUM       best_practice        aws_db_instance.app_db                     db_instance_class upsized from db.t3.small to db.t3.medium
  F006   LOW          best_practice        general                                    All four resources lack lifecycle prevent_destroy protections

  ────────────────────────────────────────────────────────────────────────
  [F001] ❗ CRITICAL — SSH ingress opened to the entire internet (0.0.0.0/0)

  The code diff explicitly changes ingress_ssh_cidr from 10.0.0.0/8 (a private RFC-1918
  range) to 0.0.0.0/0, exposing SSH (port 22) to all public IPs.

  Code: main.tf (lines 18-19)
  Plan: aws_security_group.web_sg (create)

  Recommendation:
  Revert ingress_ssh_cidr to a specific, restricted CIDR. Consider using AWS Systems
  Manager Session Manager to eliminate SSH exposure entirely.

  ────────────────────────────────────────────────────────────────────────
  [F002] ❗ CRITICAL — RDS database instance set to publicly_accessible=true

  ...
  ────────────────────────────────────────────────────────────────────────
  1,847 tokens in / 412 out · 3.2s · claude-sonnet-4-6 · anthropic

Output Formats

tfrev review --plan plan.json --output table     # Terminal (default)
tfrev review --plan plan.json --output markdown  # PR comments
tfrev review --plan plan.json --output json      # Machine consumption

The table and markdown outputs include a summary footer showing token usage, review duration, model, and provider:

1,847 tokens in / 412 out · 3.2s · claude-sonnet-4-6 · anthropic

Exit Codes

Code Meaning
0 Review passed
1 Review failed (findings at or above --fail-on severity)
2 Error (API failure, invalid input)

Cost

Each review is a single API call. Typical cost is $0.01–$0.10 per review depending on plan size and model. If the combined input exceeds the model's context window, tfrev drops context files to fit — it never splits into multiple calls.

When using AWS Bedrock, pricing is determined by your AWS Bedrock on-demand or provisioned throughput rates rather than the Anthropic API.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tfrev-2.2.0.tar.gz (46.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tfrev-2.2.0-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file tfrev-2.2.0.tar.gz.

File metadata

  • Download URL: tfrev-2.2.0.tar.gz
  • Upload date:
  • Size: 46.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tfrev-2.2.0.tar.gz
Algorithm Hash digest
SHA256 4ee0c2d3e0ea64072a01df29bd838aa1ca8fb05f6f7a290dd336adca9be9e8bf
MD5 c72b3ed6f2d3f62d25019db07c073268
BLAKE2b-256 874f127b22e5017ab8ad4e6240bf43638719a8231db90ab87108cf56a6243f64

See more details on using hashes here.

Provenance

The following attestation bundles were made for tfrev-2.2.0.tar.gz:

Publisher: publish.yml on bishalOps/tfrev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tfrev-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: tfrev-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tfrev-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21c6751757d9e1772e6086d45e4be715014159d94e5008d0137a0a231da14ef8
MD5 485b075805eac76cb8ccb3f1c1cd03a9
BLAKE2b-256 3a642f455fb188c5d56aeb52af98ea5ab332d22a33f5e85857c7780c83830936

See more details on using hashes here.

Provenance

The following attestation bundles were made for tfrev-2.2.0-py3-none-any.whl:

Publisher: publish.yml on bishalOps/tfrev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page