{"id":20334883,"url":"https://github.com/mdb/terraputs","last_synced_at":"2025-04-11T21:51:34.475Z","repository":{"id":43477783,"uuid":"381790507","full_name":"mdb/terraputs","owner":"mdb","description":"A CLI to generate Terraform outputs documentation ","archived":false,"fork":false,"pushed_at":"2024-11-14T15:23:31.000Z","size":180,"stargazers_count":9,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T17:49:32.204Z","etag":null,"topics":["terraform"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-30T17:58:50.000Z","updated_at":"2024-11-14T15:21:25.000Z","dependencies_parsed_at":"2024-11-14T18:17:01.184Z","dependency_job_id":null,"html_url":"https://github.com/mdb/terraputs","commit_stats":{"total_commits":57,"total_committers":3,"mean_commits":19.0,"dds":0.07017543859649122,"last_synced_commit":"c64f0e5bcebfa80d8ddc96da85946841fa329db4"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterraputs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterraputs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterraputs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterraputs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdb","download_url":"https://codeload.github.com/mdb/terraputs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487733,"owners_count":21112188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["terraform"],"created_at":"2024-11-14T20:38:28.584Z","updated_at":"2025-04-11T21:51:34.446Z","avatar_url":"https://github.com/mdb.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CI/CD](https://github.com/mdb/terraputs/actions/workflows/main.yml/badge.svg)](https://github.com/mdb/terraputs/actions/workflows/main.yml)\n\n# terraputs\n\nA CLI to generate Terraform outputs documentation.\n\n## What's the use case?\n\n`terraputs` analyzes the contents of a [terraform state](https://www.terraform.io/docs/language/state/index.html)\nfile and generates Markdown or HTML documentation from its [outputs](https://www.terraform.io/docs/language/values/outputs.html).\n\nA common workflow might execute `terraputs -state $(terraform show -json) \u003e outputs.md` after each\ninvocation of `terraform apply`, then commit `outputs.md` to source control or publish its contents to\noffer up-to-date documentation about resources managed by a Terraform project.\n\n\u003ca style=\"display: block;\" href=\"https://asciinema.org/a/lFUVfdhes0i1cVbtFUvzwLMKd\"\u003e\u003cimg style=\"width: 500px;\" src=\"demo.svg\"\u003e\u003c/a\u003e\n\n## Usage\n\n```\nterraputs -h\nUsage of terraputs:\n  -description string\n        Optional; a contextual description preceding the outputs. (default \"Terraform state outputs.\")\n  -heading string\n        Optional; the heading text for use in the printed output. (default \"Outputs\")\n  -output string\n        Optional; the output format. Supported values: md, html. (default \"md\")\n  -state string\n        Optional; the state JSON output by 'terraform show -json'. Read from stdin if omitted\n  -state-file string\n        Optional; the path to a local file containing 'terraform show -json' output\n```\n\nA few typical usage examples:\n\n```\n# terraputs can accept arbitrary state as a string argument on the command line:\nterraputs -state \"$(terraform show -json)\" -heading \"Terraform Outputs\"\n\n# or directly from standard input, if the -state option is omitted. to read\n# directly from terraform, consider:\nterraform show -json | terraputs -heading \"Terraform Outputs\"\n\n# or read a tfstate JSON file from the filesystem:\nterraform show -json \u003e show.json\nterraputs \u003c show.json\n```\n\n### Results examples\n\n\u003cdetails\u003e\n\n\u003csummary\u003eExample markdown output\u003c/summary\u003e\n\n```\n# Terraform Outputs\n\nTerraform state outputs.\n\n| Output | Value | Type\n| --- | --- | --- |\n| a_basic_map | map[foo:bar number:42] | map[string]interface {}\n| a_list | [foo bar] | []interface {}\n| a_nested_map | map[baz:map[bar:baz id:123] foo:bar number:42] | map[string]interface {}\n| a_sensitive_value | sensitive; redacted | string\n| a_string | foo | string\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eMarkdown output rendered via GitHub-flavored markdown\u003c/summary\u003e\n\n# Terraform Outputs\n\nTerraform state outputs.\n\n| Output | Value | Type\n| --- | --- | --- |\n| a_basic_map | map[foo:bar number:42] | map[string]interface {}\n| a_list | [foo bar] | []interface {}\n| a_nested_map | map[baz:map[bar:baz id:123] foo:bar number:42] | map[string]interface {}\n| a_sensitive_value | sensitive; redacted | string\n| a_string | foo | string\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eExample HTML output\u003c/summary\u003e\n\n```html\n\u003ch2\u003eOutputs\u003c/h2\u003e\n\u003cp\u003eTerraform state outputs.\u003c/p\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eOutput\u003c/th\u003e\n    \u003cth\u003eValue\u003c/th\u003e\n    \u003cth\u003eType\u003c/th\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_basic_map\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e{\n  \"foo\": \"bar\",\n  \"number\": 42\n}\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003emap[string]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_list\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e[\n  \"foo\",\n  \"bar\"\n]\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003e[]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_nested_map\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e{\n  \"baz\": {\n    \"bar\": \"baz\",\n    \"id\": \"123\"\n  },\n  \"foo\": \"bar\",\n  \"number\": 42\n}\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003emap[string]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_sensitive_value\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003esensitive; redacted\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_string\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e\"foo\"\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n  \u003c/tr\u003e\n\n\u003c/table\u003e\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eHTML output rendered via GitHub-flavored markdown\u003c/summary\u003e\n\n\u003ch2\u003eOutputs\u003c/h2\u003e\n\u003cp\u003eTerraform state outputs.\u003c/p\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eOutput\u003c/th\u003e\n    \u003cth\u003eValue\u003c/th\u003e\n    \u003cth\u003eType\u003c/th\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_basic_map\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e{\n  \"foo\": \"bar\",\n  \"number\": 42\n}\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003emap[string]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_list\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e[\n  \"foo\",\n  \"bar\"\n]\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003e[]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_nested_map\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e{\n  \"baz\": {\n    \"bar\": \"baz\",\n    \"id\": \"123\"\n  },\n  \"foo\": \"bar\",\n  \"number\": 42\n}\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003emap[string]interface {}\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_sensitive_value\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003esensitive; redacted\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd\u003ea_string\u003c/td\u003e\n    \u003ctd\u003e\u003cpre\u003e\"foo\"\u003c/pre\u003e\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n  \u003c/tr\u003e\n\n\u003c/table\u003e\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdb%2Fterraputs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdb%2Fterraputs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdb%2Fterraputs/lists"}