人工智能 基础设施即代码 生成器。

• 描述
• 用例与示例提示
  • 生成 IaC
  • 生成配置文件
  • 生成 CI/CD 流水线
  • 生成策略即代码
  • 生成实用工具
  • 命令行构建器
  • 查询构建器
• 使用说明
  • 安装
  • 配置
  • 使用
    • 命令行
      • 列出模型
      • 生成代码
    • 通过 Docker
    • 作为库
  • 从 v4 升级到 v5
    • 配置变化
    • CLI 调用变化
    • 模型使用与支持变化
    • 其他变化
• 示例输出
• 故障排除
• 许可证

描述

aiac 是一个库和命令行工具，用于通过 LLM 提供商（如 OpenAI、Amazon Bedrock 和 Ollama）生成 IaC（基础设施即代码） 模板、配置、实用工具、查询等。

CLI 允许您请求模型为不同场景生成模板（例如，“为 AWS EC2 获取 Terraform”）。它会向所选提供商组成适当的请求，并将生成的代码存储到文件中，和/或打印到标准输出。

用户可以使用简单的配置文件定义多个“后端”，以针对不同的 LLM 提供商和环境。

用例与示例提示

生成 IaC

• aiac terraform for a highly available eks
• aiac pulumi golang for an s3 with sns notification
• aiac cloudformation for a neptundb

生成配置文件

• aiac dockerfile for a secured nginx
• aiac k8s manifest for a mongodb deployment

生成 CI/CD 流水线

• aiac jenkins pipeline for building nodejs
• aiac github action that plans and applies terraform and sends a slack notification

生成策略即代码

• aiac opa policy that enforces readiness probe at k8s deployments

生成实用工具

• aiac python code that scans all open ports in my network
• aiac bash script that kills all active terminal sessions

命令行构建器

• aiac kubectl that gets ExternalIPs of all nodes
• aiac awscli that lists instances with public IP address and Name

查询构建器

• aiac mongo query that aggregates all documents by created date
• aiac elastic query that applies a condition on a value greater than some value in aggregation
• aiac sql query that counts the appearances of each row in one table in another table based on an id column

使用说明

在安装/运行 aiac 之前，您可能需要配置您的 LLM 提供商或收集一些信息。

对于 OpenAI，您需要一个 API 密钥才能使 aiac 正常工作。有关更多信息，请参阅 OpenAI 的定价模型。如果您未使用 OpenAI 托管的 API（例如，您可能正在使用 Azure OpenAI），则还需要提供 API URL 端点。

对于 Amazon Bedrock，您需要一个启用了 Bedrock 的 AWS 账户，并且能够访问相关模型。有关更多信息，请参阅 Bedrock 文档。

对于 Ollama，您只需要本地 Ollama API 服务器的 URL，包括 /api 路径前缀。默认值为 http://localhost:11434/api。Ollama 不提供身份验证机制，但在使用代理服务器的情况下可能会有身份验证机制。目前 aiac 尚不支持此场景。

安装

通过 brew：

brew tap gofireflyio/aiac https://github.com/gofireflyio/aiac
brew install aiac

使用 docker：

docker pull ghcr.io/gofireflyio/aiac

使用 go install：

go install github.com/gofireflyio/aiac/v5@latest

或者，您可以克隆仓库并从源代码构建：

git clone https://github.com/gofireflyio/aiac.git
go build

aiac 也已在 Arch Linux 用户仓库 (AUR) 中提供，分别为 aiac（从源代码编译）和 aiac-bin（下载已编译的可执行文件）。

配置

aiac 通过 TOML 配置文件进行配置。除非特别指定路径，否则 aiac 会在用户的 XDG_CONFIG_HOME 目录中查找配置文件，具体路径为 ${XDG_CONFIG_HOME}/aiac/aiac.toml。在类 Unix 操作系统上，默认路径为 ~/.config/aiac/aiac.toml。如果您想使用其他路径，请使用 --config 或 -c 标志指定文件路径。

配置文件定义了一个或多个命名后端。每个后端都有一个类型，用于标识 LLM 提供商（例如，“openai”、“bedrock”、“ollama”），以及与该提供商相关的各种设置。可以配置同一 LLM 提供商的多个后端，例如用于“staging”和“production”环境。

以下是一个示例配置文件：

default_backend = "official_openai"   # 当未选择后端时的默认后端

[backends.official_openai]
type = "openai"
api_key = "API KEY"
# Or

# api_key = "$OPENAI_API_KEY"
default_model = "gpt-4o"              # 此后端默认使用的模型

[backends.azure_openai]
type = "openai"
url = "https://tenant.openai.azure.com/openai/deployments/test"
api_key = "API KEY"
api_version = "2023-05-15"            # 可选
auth_header = "api-key"               # 默认为 "Authorization"
extra_headers = { X-Header-1 = "one", X-Header-2 = "two" }

[backends.aws_staging]
type = "bedrock"
aws_profile = "staging"
aws_region = "eu-west-2"

[backends.aws_prod]
type = "bedrock"
aws_profile = "production"
aws_region = "us-east-1"
default_model = "amazon.titan-text-express-v1"

[backends.localhost]
type = "ollama"
url = "http://localhost:11434/api"     # 这是默认值

注意事项：

1. 每个后端都可以设置一个默认模型（通过配置键 default_model）。如果未提供，默认情况下，未指定模型的调用将会失败。
2. 类型为 "openai" 的后端可以通过设置 auth_header 来更改用于授权的头部字段。默认为 "Authorization"，但 Azure OpenAI 使用的是 "api-key"。当头部字段为 "Authorization" 或 "Proxy-Authorization" 时，请求中的值会是 "Bearer API_KEY"；如果是其他值，则直接使用 "API_KEY"。
3. 类型为 "openai" 和 "ollama" 的后端支持通过 extra_headers 设置向 aiac 发出的每个请求添加额外的头部信息。

使用方法

创建配置文件后，您就可以开始生成代码了，只需引用后端名称即可。您可以从命令行使用 aiac，也可以将其作为 Go 库来使用。

命令行

列出模型

在开始生成代码之前，您可以列出某个后端中所有可用的模型：

aiac -b aws_prod --list-models

这将返回所有可用模型的列表。请注意，根据 LLM 提供商的不同，此列表可能包含对该特定账户不可访问或未启用的模型。

生成代码

默认情况下，aiac 会将提取出的代码打印到标准输出，并打开一个交互式 shell，允许与模型对话、重试请求、将输出保存到文件、复制代码到剪贴板等操作：

aiac terraform for AWS EC2

这将使用配置文件中的默认后端以及该后端的默认模型（前提是已定义）。若要使用特定后端，请提供 --backend 或 -b 标志：

aiac -b aws_prod terraform for AWS EC2

若要使用特定模型，请提供 --model 或 -m 标志：

aiac -m gpt-4-turbo terraform for AWS EC2

您可以让 aiac 将生成的代码保存到指定文件中：

aiac terraform for eks --output-file=eks.tf

您还可以使用标志将完整的 Markdown 输出一并保存：

aiac terraform for eks --output-file=eks.tf --readme-file=eks.md

如果您希望 aiac 打印完整的 Markdown 输出而不是提取出的代码到标准输出，可以使用 -f 或 --full 标志：

aiac terraform for eks -f

您也可以在非交互模式下使用 aiac，仅将生成的代码打印到标准输出，并可选择使用上述标志将其保存到文件，只需提供 -q 或 --quiet 标志：

aiac terraform for eks -q

在静默模式下，您还可以通过提供 --clipboard 标志将生成的代码发送到剪贴板：

aiac terraform for eks -q --clipboard

请注意，在这种情况下，aiac 不会退出，直到剪贴板的内容发生变化。这是由于剪贴板的工作机制所致。

通过 Docker

所有相同的指令都适用，只是您需要运行一个 Docker 镜像：

docker run \
    -it \
    -v ~/.config/aiac/aiac.toml:~/.config/aiac/aiac.toml \
    ghcr.io/gofireflyio/aiac terraform for ec2

作为库

您也可以将 aiac 作为 Go 库来使用：

package main

import (
    "context"
    "log"
    "os"

    "github.com/gofireflyio/aiac/v5/libaiac"
)

func main() {
    aiac, err := libaiac.New() // 将加载默认配置路径。
                               // 您也可以指定路径：libaiac.New("/path/to/aiac.toml")
    if err != nil {
        log.Fatalf("创建 aiac 对象失败: %s", err)
    }

    ctx := context.TODO()

    models, err := aiac.ListModels(ctx, "后端名称")
    if err != nil {
        log.Fatalf("列出模型失败: %s", err)
    }

    chat, err := aiac.Chat(ctx, "后端名称", "模型名称")
    if err != nil {
        log.Fatalf("启动聊天失败: %s", err)
    }

    res, err := chat.Send(ctx, "为 eks 生成 Terraform 配置")
    res, err = chat.Send(ctx, "区域必须是 eu-central-1")
}

从 v4 升级到 v5

版本 5.0.0 根据社区反馈，对命令行和库形式的 aiac API 进行了重大更改。

配置的变化

在 v5 之前，没有配置文件或命名后端的概念。用户必须通过命令行参数或环境变量提供与特定 LLM 提供商通信所需的所有信息，而库则允许创建只能与一个 LLM 提供商对话的“客户端”对象。

现在，后端仅通过配置文件进行配置。有关说明，请参阅配置部分。诸如 --api-key、--aws-profile 等特定于提供商的标志（以及相应的环境变量，如果有的话）已不再被接受。

自 v5 起，后端也有了名称。以前，--backend 和 -b 标志指的是 LLM 提供商的名称（例如，“openai”、“bedrock”、“ollama”）。现在，它们指你在配置文件中定义的任何名称：

[backends.my_local_llm]
type = "ollama"
url = "http://localhost:11434/api"

在这里，我们配置了一个名为“my_local_llm”的 Ollama 后端。当你想使用这个后端生成代码时，将使用 -b my_local_llm 而不是 -b ollama，因为同一个 LLM 提供商可能有多个后端。

CLI 调用的变化

在 v5 之前，命令行分为三个子命令：get、list-models 和 version。由于 CLI 的这种层次结构，如果参数位于“错误的位置”，可能会不被接受。例如，--model 标志必须紧跟在“get”之后，否则不会被接受。而在 v5 中，不再有子命令，因此参数的位置不再重要。

list-models 子命令已被 --list-models 标志取代，version 子命令已被 --version 标志取代。

v5 之前：

aiac -b ollama list-models

自 v5 起：

aiac -b my_local_llm --list-models

在早期版本中，“get”实际上是一个子命令，并不是真正发送给 LLM 提供商的提示的一部分。自 v5 起，不再有“get”子命令，因此你不再需要在提示中添加这个词。

v5 之前：

aiac get terraform for S3 bucket

自 v5 起：

aiac terraform for S3 bucket

不过，添加“get”或“generate”这两个词并不会有任何问题，因为 v5 会在接收到这些词时将其直接移除。

模型使用和支持的变化

在 v5 之前，每个 LLM 提供商的模型都硬编码在每个后端实现中，且每个提供商都有一个硬编码的默认模型。这极大地限制了项目的可用性，每当有新模型被添加或弃用时，我们都必须更新 aiac。另一方面，我们可以手动从提供商文档中提取每个模型的上下文长度和类型等信息，从而提供更详细的信息。

自 v5 起，aiac 不再硬编码任何模型，包括默认模型。它不会再尝试验证你选择的模型是否真的存在。--list-models 标志现在会直接联系所选后端的 API，以获取支持的模型列表。在生成代码时设置模型，只是将模型名称原样发送给 API。此外，不再为每个后端硬编码默认模型，用户可以在配置文件中定义自己的默认模型：

[backends.my_local_llm]
type = "ollama"
url = "http://localhost:11434/api"
default_model = "mistral:latest"

在 v5 之前，aiac 同时支持完成模型和聊天模型。自 v5 起，它只支持聊天模型。由于没有任何 LLM 提供商的 API 会明确标注某个模型是完成模型还是聊天模型（甚至是否是图像或视频模型），--list-models 标志可能会列出一些实际上无法使用的模型，尝试使用这些模型会导致来自提供商 API 的错误。我们决定放弃对完成模型的支持，是因为完成模型需要为 API 设置最大令牌数来生成内容（至少在 OpenAI 中是这样），而我们无法在不知道上下文长度的情况下做到这一点。相比之下，聊天模型不仅更有用，而且没有这一限制。

其他变化

大多数 LLM 提供商的 API 在返回提示响应时，都会包含一个“停止原因”，说明为什么响应会在那里结束。通常，响应应该是因为模型完成了生成而结束，但有时响应可能会因为模型的上下文长度或用户的令牌使用量而被截断。当响应并非因生成完成而“停止”时，就被称为“截断”。在 v5 之前，如果 API 返回响应被截断，aiac 会返回错误。自 v5 起，不再返回错误，因为似乎有些提供商并没有返回准确的停止原因。相反，库会将停止原因作为输出的一部分返回，以便用户自行决定如何继续。

示例输出

命令行提示：

aiac dockerfile for nodejs with comments

输出：

FROM node:latest

# 创建应用目录
WORKDIR /usr/src/app

# 安装应用依赖
# 使用通配符确保无论是否有 package-lock.json，package.json 都会被复制过来（npm@5+）
COPY package*.json ./

RUN npm install
# 如果您正在为生产构建代码
# RUN npm ci --only=production

# 打包应用源代码
COPY . .

EXPOSE 8080
CMD [ "node", "index.js" ]

故障排除

你可能会遇到的大多数错误都来自 LLM 提供商的 API，例如 OpenAI 或 Amazon Bedrock。一些常见的错误包括：

• “[insufficient_quota] 您已超出当前配额，请检查您的计划和账单详情”： 如说明部分所述，OpenAI 是一项付费 API，会提供一定数量的免费额度。此错误表示您已超出免费或付费配额。您需要充值才能继续使用。

• “[tokens] 已达到速率限制...”： OpenAI API 采用速率限制机制，具体说明请参见此处。aiac 只执行单独的请求，无法绕过或防止这些速率限制。如果你以编程方式使用 aiac，则需要自行实施限流措施。有关提示，请参阅这里。

许可证

本代码根据Apache License 2.0条款发布。

AIAC 快速上手指南

aiac 是一款基于大语言模型（LLM）的基础设施即代码（IaC）生成工具。它支持通过自然语言提示词，自动生成 Terraform、CloudFormation、Dockerfile、K8s Manifest、CI/CD 流水线等代码模板。支持的后端包括 OpenAI、Amazon Bedrock 和 Ollama（本地部署）。

环境准备

在开始之前，请确保满足以下条件：

• 操作系统：macOS, Linux (包括 Arch Linux), 或任何支持 Docker 的环境。
• 前置依赖：
  • 若使用源码安装：需安装 Go (建议 1.20+)。
  • 若使用 Homebrew (macOS)：需安装 Homebrew。
• LLM 凭证：
  • OpenAI: 需要有效的 API Key。
  • Amazon Bedrock: 需要配置好权限的 AWS 账号及凭证。
  • Ollama: 需在本地运行 Ollama 服务（默认端口 11434），无需 API Key。

安装步骤

选择以下任意一种方式进行安装：

方式一：使用 Homebrew (推荐 macOS 用户)

brew tap gofireflyio/aiac https://github.com/gofireflyio/aiac
brew install aiac

方式二：使用 Go 安装

go install github.com/gofireflyio/aiac/v5@latest

方式三：使用 Docker

docker pull ghcr.io/gofireflyio/aiac

方式四：Arch Linux (AUR)

# 编译安装
yay -S aiac
# 或直接下载二进制包
yay -S aiac-bin

基本使用

1. 配置文件设置

aiac v5 版本强制要求通过 TOML 配置文件管理后端。默认配置路径为 ~/.config/aiac/aiac.toml。

创建配置文件并填入你的 LLM 信息：

# ~/.config/aiac/aiac.toml

# 设置默认后端名称
default_backend = "my_openai"

[backends.my_openai]
type = "openai"
api_key = "sk-..."  # 替换为你的 OpenAI API Key，或使用 "$OPENAI_API_KEY"
default_model = "gpt-4o"

# 如果使用本地 Ollama
[backends.local_ollama]
type = "ollama"
url = "http://localhost:11434/api"
default_model = "llama3"

注意：如果你使用的是国内网络访问 OpenAI，可能需要在配置中通过代理环境变量或在 extra_headers 中调整，或者直接使用部署在国内的兼容 OpenAI 接口的模型服务（修改 url 地址即可）。

2. 生成代码

配置完成后，即可通过自然语言生成代码。

交互式生成（默认模式）： 运行后会进入交互界面，可多次对话、重试或直接保存文件。

aiac terraform for AWS EC2

指定后端和模型：

aiac -b local_ollama -m llama3 dockerfile for a secured nginx

非交互式模式（直接输出代码到终端）： 适合脚本调用或快速查看。

aiac terraform for eks -q

生成并保存到文件：

# 生成代码并保存为 main.tf
aiac terraform for a highly available eks --output-file=main.tf

# 同时保存代码文件和说明文档
aiac pulumi golang for an s3 with sns notification --output-file=main.go --readme-file=README.md

复制到剪贴板：

aiac kubectl that gets ExternalIPs of all nodes -q --clipboard

3. 查看可用模型

列出指定后端下所有可用的模型：

aiac -b my_openai --list-models