subhamay-bhattacharyya/aws-serverless-security
GitHub: subhamay-bhattacharyya/aws-serverless-security
一个涵盖七层纵深防御的 AWS 无服务器安全实战工作坊,结合 Bedrock AI 驱动的自动化安全事件响应能力。
Stars: 0 | Forks: 0
# terraform-docs
[](https://github.com/terraform-docs/terraform-docs/actions) [](https://pkg.go.dev/github.com/terraform-docs/terraform-docs) [](https://goreportcard.com/report/github.com/terraform-docs/terraform-docs) [](https://codecov.io/gh/terraform-docs/terraform-docs) [](https://github.com/terraform-docs/terraform-docs/blob/master/LICENSE) [](https://github.com/terraform-docs/terraform-docs/releases)

## 什么是 terraform-docs
一个用于从 Terraform 模块生成多种格式文档的实用工具。
## 文档
- **用户**
- 阅读 [用户指南] 了解如何使用 terraform-docs
- 阅读 [格式指南] 了解 terraform-docs 的不同输出格式
- 参考 [配置文件参考] 查看所有可用的配置选项
- **开发者**
- 提交 pull request 前请阅读 [贡献指南]
访问 [我们的网站] 查看所有文档。
## 安装
可以使用 `go get` 安装最新版本:
```
GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.12.0
```
**注意:** 要下载 `v0.9.1`(包含)**之前**的任何版本,你需要使用旧的模块命名空间(`segmentio`):
```
# 仅适用于 v0.9.1 及更早版本
GO111MODULE="on" go get github.com/segmentio/terraform-docs@v0.9.1
```
**注意:** 请使用最新版本的 Go 来执行此操作,我们使用的是 1.16.0,但理想情况下应是 Go 1.15 或更高版本。
这会将 `terraform-docs` 放置在 `$(go env GOPATH)/bin` 中。如果安装后遇到 `terraform-docs: command not found` 错误,你可能需要将该目录添加到你的 `$PATH` 中,如[此处]所示,或者通过克隆仓库并运行 `make build` 进行手动安装,这会将 `terraform-docs` 放置在:
```
$(go env GOPATH)/src/github.com/terraform-docs/terraform-docs/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/terraform-docs
```
稳定的二进制文件也可以在 [releases] 页面获取。要安装,请从 "Assets" 中下载适用于你平台的二进制文件,并将其放入你的 `$PATH` 中:
```
curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.12.0/terraform-docs-v0.12.0-$(uname)-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /some-dir-in-your-PATH/terraform-docs
```
**注意:** Windows 版本为 `ZIP` 格式。
如果你是 Mac OS X 用户,可以使用 [Homebrew]:
```
brew install terraform-docs
```
或者
```
brew install terraform-docs/tap/terraform-docs
```
Windows 用户可以使用 [Scoop] 安装:
```
scoop bucket add terraform-docs https://github.com/terraform-docs/scoop-bucket
scoop install terraform-docs
```
或者使用 [Chocolatey]:
```
choco install terraform-docs
```
或者,你也可以将 `terraform-docs` 作为容器运行:
```
docker run quay.io/terraform-docs/terraform-docs:0.12.0
```
**注意:** Docker 标签 `latest` 指向 _最新_ 的稳定发布版本,而 `edge` 指向任何时间点 `master` 分支的 HEAD。
## 社区
- 在 [Slack] 上讨论 terraform-docs
## 许可证
MIT License - Copyright (c) 2021 The terraform-docs Authors.
标签:AI代理, AWS, Bedrock, CISA项目, Cognito, DPI, DynamoDB, EC2, ECS, EventBridge, Go语言, GuardDuty, IaC, Kiro, Lambda, Secrets Manager, StruQ, Terraform, VPC, WAF, 人工智能, 代码硬化, 安全事件响应, 数据加密, 文档生成, 无服务器, 用户模式Hook绕过, 程序破解, 纵深防御, 网络调试, 网络隔离, 自动化, 自适应认证, 边缘保护