# Terraform Module Inventory (`junipr/terraform-module-inventory`) Actor

Inventory Terraform modules, providers, resources, variables, outputs, version constraints, backend declarations, and module source references from Terraform files without running plans or touching cloud accounts.

- **URL**: https://apify.com/junipr/terraform-module-inventory.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.90 / 1,000 page auditeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Terraform Module Inventory

### Store Positioning

**Store title:** Terraform Module Inventory

**Short description:** Inventory Terraform modules, providers, resources, variables, outputs, version constraints, backend declarations, and module source references from Terraform files without running plans or touching cloud accounts.

**SEO title:** Terraform Module Inventory — technical SEO, web, and domain audit

**SEO description:** Inventory Terraform modules, providers, resources, variables, outputs, version constraints, backend declarations, and module source references from Terraform files without running plans or touching cloud accounts. Use it to find crawlability, indexability, security, metadata, and page-quality issues with evidence-backed rows and audit reports.

**Categories:** DEVELOPER\_TOOLS

**Keywords:** terraform, module, inventory, web/domain audit

### Pay-Per-Event Pricing

This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model.

- Tier: W1 — Web/domain audit
- Primary event: `page-audited` at $0.00490 base
- Default max charge: $10.00
- Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount

Event set:

- `actor-start`: base $0.00500, GOLD $0.00400. Terraform Module Inventory: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `page-audited`: base $0.00490, GOLD $0.00392. Terraform Module Inventory: charged when page audited is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `record-extracted`: base $0.00372, GOLD $0.00298. Terraform Module Inventory: charged when record extracted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `finding-emitted`: base $0.00372, GOLD $0.00298. Terraform Module Inventory: charged when finding emitted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `audit-report-generated`: base $0.05000, GOLD $0.04000. Terraform Module Inventory: charged when audit report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.

The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts the configured report event before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written.

### Public Task Concepts

- Extract Terraform Module rows from supplied public inputs
- Inventory Terraform Module fields across a capped sample
- Normalize Terraform Module evidence for delivery
- Flag missing Terraform Module data before delivery
- Export Terraform Module records with source URLs

Inventory Terraform modules, providers, resources, variables, outputs, version constraints, backend declarations, and module source references from Terraform files without running plans or touching cloud accounts.

### What it does

- Accept raw `.tf` content, public Terraform file URLs, repository file URLs, or bundled file inputs.
- Parse Terraform/HCL-style blocks where possible.
- Inventory module, provider, resource, data source, variable, output, locals, backend, required provider, and required Terraform version blocks.
- Identify module sources, module version pins, provider constraints, and unpinned/floating source references.
- Emit normalized infrastructure inventory rows.
- Generate module map and provider summary.

### What it does not do

- No `terraform plan`, `terraform apply`, state-file access, cloud API calls, secret-value reporting, or deployability guarantee.

### Input fields

Primary inputs from the locked actor spec: `terraformFiles`, `terraformFileUrls`, `repositoryUrls`, `modulePaths`, `includeResources`, `includeDataSources`, `includeVariables`, `includeOutputs`, `includeProviderConstraints`, `includeBackendBlocks`, `includeWarnings`, `maxFiles`, `timeoutMs`. `maxChargeUsd` keeps runs capped during production use.

### Output fields

Dataset rows include: `sourceUrl`, `filePath`, `blockType`, `blockName`, `providerName`, `resourceType`, `resourceName`, `moduleName`, `moduleSource`, `moduleVersion`, `versionConstraint`, `variableName`, `defaultValuePresent`, `outputName`, `sensitiveFlag`, `lineNumber`, `warning`.

### Starter example

Use `examples/input.tiny.json` as a small starter input. Keep the first run capped and review the dataset before increasing limits.

### Public task examples

- Run Terraform Module Inventory on supplied sample data: Run Terraform Module Inventory on supplied sample data using a small bounded input.
- Generate a Terraform Module Inventory QA report: Generate a Terraform Module Inventory QA report using a small bounded input.
- Find invalid rows with Terraform Module Inventory: Find invalid rows with Terraform Module Inventory using a small bounded input.
- Create a capped local endpoint readiness check for Terraform Module Inventory: Create a capped local endpoint readiness check for Terraform Module Inventory using a small bounded input.
- Prepare Terraform Module Inventory output for downstream automation: Prepare Terraform Module Inventory output for downstream automation using a small bounded input.

### Public source provenance

The starter input inventories the public `terraform-aws-vpc` simple example at immutable commit `3ffbd46fb1c7733e1b34d8666893280454e27436`. Public tasks cover its main, version, variable, and output files without running Terraform or accessing a cloud account.

### Reports

- `terraform-module-inventory.md`
- `terraform-module-map.json`
- `terraform-provider-summary.csv`
- `terraform-resource-inventory.csv`
- `terraform-version-warnings.json`

### Limitations and safe use

Start with supplied-input runs, then enable live endpoints only with tight caps, domain allowlists, and no secrets in public examples.

# Actor input Schema

## `terraformFiles` (type: `array`):

Terraform Files to inspect during the run.

## `terraformFileUrls` (type: `array`):

Public terraform file URLs to fetch or inspect for Terraform Module Inventory.

## `repositoryUrls` (type: `array`):

Public repository URLs to fetch or inspect for Terraform Module Inventory.

## `modulePaths` (type: `array`):

Module Paths controls Terraform Module Inventory processing for the supplied inputs; keep values conservative for first runs.

## `includeResources` (type: `boolean`):

Include resources in output rows or reports when available.

## `includeDataSources` (type: `boolean`):

Include data sources in output rows or reports when available.

## `includeVariables` (type: `boolean`):

Include variables in output rows or reports when available.

## `includeOutputs` (type: `boolean`):

Include outputs in output rows or reports when available.

## `includeProviderConstraints` (type: `boolean`):

Include provider constraints in output rows or reports when available.

## `includeBackendBlocks` (type: `boolean`):

Include backend blocks in output rows or reports when available.

## `includeWarnings` (type: `boolean`):

Include warnings in output rows or reports when available.

## `maxFiles` (type: `number`):

Maximum files to process in one run; keep defaults low for safe first runs.

## `timeoutMs` (type: `number`):

Maximum time in milliseconds allowed for the Terraform Module Inventory operation before it is treated as timed out.

## `maxChargeUsd` (type: `number`):

Maximum estimated PPE charge allowed for the run before the actor stops gracefully.

## Actor input object example

```json
{
  "terraformFiles": [],
  "terraformFileUrls": [
    "https://raw.githubusercontent.com/terraform-aws-modules/terraform-aws-vpc/3ffbd46fb1c7733e1b34d8666893280454e27436/examples/simple/main.tf"
  ],
  "repositoryUrls": [],
  "modulePaths": [],
  "includeResources": true,
  "includeDataSources": true,
  "includeVariables": true,
  "includeOutputs": true,
  "includeProviderConstraints": true,
  "includeBackendBlocks": true,
  "includeWarnings": true,
  "maxFiles": 1,
  "timeoutMs": 10000,
  "maxChargeUsd": 1
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("junipr/terraform-module-inventory").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("junipr/terraform-module-inventory").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call junipr/terraform-module-inventory --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,junipr/terraform-module-inventory"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/IA8AQ8hrsDqj2PdbX/builds/Q9DEFiZYIG049kJ5L/openapi.json