{"adoption": {"forks": 601, "observed_at": "2026-08-28T04:09:00.312916+00:00", "stars": 4814}, "canonical_url": "https://ross.abutalabs.com/products/terraform-docs", "card": {"archived": false, "artifact_type": "cli-tool", "description": "Generate documentation from Terraform modules in various output formats", "domain": ["infrastructure-as-code", "developer-tools", "documentation"], "enriched": true, "function": ["documentation", "cli", "developer-tools"], "health_score": 96, "homepage": "https://terraform-docs.io", "language": "Go", "license": "MIT", "license_family": "permissive", "maturity": "stable", "member_repos": ["terraform-docs/terraform-docs"], "name": "terraform-docs/terraform-docs", "platform": ["windows", "bsd", "cli", "go"], "pushed_at": "2026-08-03T06:52:24+00:00", "repo": "terraform-docs/terraform-docs", "stars": 4814, "tags": ["terraform", "terraform-modules", "doc-generator", "markdown", "ci-friendly", "infrastructure-as-code", "devops", "linux", "macos", "docker"], "topics": ["terraform", "terraform-docs", "terraform-modules", "documentation", "generator", "golang"], "urls": [], "use_cases": ["generate README documentation for a Terraform module", "document terraform module inputs and outputs automatically", "inject terraform docs into markdown file in CI", "output terraform module docs as  or asciidoc", "keep terraform module documentation up to date in pull requests", "recursively generate docs for terraform submodules"], "what_it_is": "terraform-docs is a CLI utility that generates documentation from Terraform modules in various output formats such as Markdown, AsciiDoc, JSON, and pretty text. It extracts inputs, outputs, providers, and resources from Terraform code and can inject generated docs into README files, including via a GitHub Action for CI automation.", "when_to_avoid": ["you need documentation for non-Terraform infrastructure code", "you want hand-authored, free-form architecture docs rather than extracted module metadata"], "when_to_choose": ["you maintain Terraform modules and want auto-generated, consistent documentation", "you want CI-friendly doc generation with output checking and injection into READMEs", "you need multiple output formats (Markdown, AsciiDoc, JSON) or plugin-based custom formatters"]}, "data_as_of": "2026-08-30T08:39:29.467469+00:00", "members": [{"path": "/products/terraform-docs", "repo": "terraform-docs/terraform-docs", "role": "main", "score": 83}], "provenance": {"archived": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "artifact_type": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "description": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "domain": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "enriched": {"inputs": [], "kind": "computed", "method": "enrichment_status"}, "function": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "health_score": {"inputs": ["days_since_push", "days_since_release", "archived"], "kind": "computed", "method": "health_v1"}, "homepage": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "language": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "license": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "license_family": {"inputs": ["license"], "kind": "computed", "method": "license_family"}, "maturity": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "member_repos": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "name": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "platform": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "pushed_at": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "repo": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "stars": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "tags": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "topics": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "urls": {"kind": "observed", "observed_at": "2026-08-28T04:09:00.312916+00:00", "source": "github"}, "use_cases": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "what_it_is": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "when_to_avoid": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}, "when_to_choose": {"confidence": null, "enriched_at": "2026-08-29T18:18:34.979113+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "68d4fb207489391c4f51828d52e46c1dcf5a802fe09c8da725c300aba2dd9d57", "fetched_at": "2026-08-28T04:09:00.312916+00:00", "kind": "readme", "missing": false, "url": "https://github.com/terraform-docs/terraform-docs"}, {"content_hash": "4c7d6d8cae50e7eded4119cb49b305159a5bf5822dcd90b2bef9c7c81cfae725", "fetched_at": "2026-08-29T09:01:41.310281+00:00", "kind": "homepage", "missing": false, "url": "https://terraform-docs.io"}, {"content_hash": "229c0948af171cd2286a6adb4a4d7f1bdb01cf4e3ae5cf474e945732dfe0571f", "fetched_at": "2026-08-29T09:01:41.319256+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/user-guide/installation"}, {"content_hash": "8a43f0072598d5ae860a5649e1f1440b6fddfeedb44e2e7d50afe3ba77258833", "fetched_at": "2026-08-29T09:01:41.321359+00:00", "kind": "site_page", "missing": false, "url": "https://terraform-docs.io/reference/terraform-docs"}], "taxonomy_version": 1}}, "score": {"components": {"activity": 95, "longevity": 100, "rhythm": 59}, "computed_at": "2026-09-03T02:20:16.233290+00:00", "flags": [], "formula": "round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)", "inputs": {"age_days": 3734, "days_push": 30, "days_rel": 115, "gap_med": 116, "n_releases_24m": 6}, "score": 83, "version": 2}, "staleness": {"enrichment_outdated": false, "low_confidence": false, "scrape_days": 9, "stale_scrape": false}}