CLI 参考

aisix 二进制文件用于运行 AISIX AI 网关，并提供处理声明式 resources.yaml 文件的 validate 子命令。该子命令不会启动任何监听器，因此可以安全地用于工作站或 CI。

Usage: aisix --config <CONFIG>
       aisix <COMMAND>

命令	用途
`aisix --config <CONFIG>`	使用指定的启动配置文件启动网关。请参阅启动配置参考。
`aisix validate --resources <FILE>`	在不启动网关的情况下检查资源文件。

运行官方容器镜像时，请直接调用二进制文件：

docker run --rm --entrypoint /usr/local/bin/aisix ghcr.io/api7/aisix:latest --help

验证资源文件

aisix validate 会运行网关加载资源文件时使用的相同流水线——读取、${VAR} 插值、名称引用解析、规范 schema 验证和交叉引用检查——但不会启动任何监听器。可以在启动或重新加载前将其用作预检查，也可以将其用作配置变更的 CI 门禁。

aisix validate --resources resources.yaml

选项	必填	说明
`--resources <FILE>`	是	要验证的资源文件路径。

文件中的 ${VAR} 引用会根据 validate 进程自身的环境进行解析。请使用网关将收到的相同变量运行该命令，否则验证会因无法解析引用而失败。

退出码

退出码	含义
`0`	文件加载成功，并将摘要打印到标准输出。
非零	文件加载失败，并将完整的聚合错误报告打印到标准错误。

成功时：

OK: resources.yaml loaded 3 resource(s)

失败时，会统一报告整个文件中的所有问题，并指出资源类型、条目和字段：

resources file resources.yaml: 3 error(s):
  - provider_keys[0]: field `api_key`: environment variable `OPENAI_API_KEY` is unset or empty
  - models[0] ("gpt-4o-mini"): `provider_key` references unknown provider key "openai-main" (no provider_keys are defined in this file)
  - api_keys[0] ("quickstart-caller"): `key_env` environment variable `CALLER_API_KEY` is unset or empty

使用容器镜像进行验证

如果本地没有二进制文件，请通过 Docker 运行相同检查。挂载文件并传入该文件引用的环境变量：

docker run --rm \
  -v "$(pwd)/resources.yaml:/etc/aisix/resources.yaml:ro" \
  -e OPENAI_API_KEY \
  -e CALLER_API_KEY \
  --entrypoint /usr/local/bin/aisix \
  ghcr.io/api7/aisix:latest \
  validate --resources /etc/aisix/resources.yaml

下一步

按照开源 AISIX 网关快速入门，使用资源文件运行网关。
通过配置状态端点确认运行中的网关加载了哪些内容。

验证资源文件​

退出码​

使用容器镜像进行验证​

下一步​

验证资源文件

退出码

使用容器镜像进行验证

下一步