valqore

环境要求

• 已安装并启动 Docker（镜像可在任何支持 Docker 的环境运行）
• 扫描本地文件时需在存放 YAML/Terraform 文件的目录下执行命令
• 如需集群级强制策略：已安装 helm 与 kubectl，并有一个可访问的 Kubernetes 集群
• 无需注册账号、无需 API Key、无需额外配置文件

安装与启动步骤

1. 1拉取镜像

   从公开 GHCR 仓库拉取 Valqore 引擎镜像，镜像免费公开、无需注册登录。

   docker pull ghcr.io/valqore/engine:latest

   复制

2. 2扫描单个文件

   把当前目录挂载到容器 /work，对 deploy.yaml 做评估并输出 0-100 评分与结论。请确保 deploy.yaml 在当前目录。

   docker run --rm -v "$PWD:/work" -w /work ghcr.io/valqore/engine:latest valqore evaluate deploy.yaml --score

   复制

3. 3设置命令别名

   docker run 前缀太长，配置别名后即可简写为 valqore 。bash/zsh 用 alias，Windows 用 PowerShell 函数。

   alias valqore='docker run --rm -v "$PWD:/work" -w /work ghcr.io/valqore/engine:latest valqore'

   复制

4. 4Windows 配置别名

   PowerShell 用户用函数方式定义别名，之后同样可以直接使用 valqore 命令。新开窗口后需重新定义或写入 profile。

   function valqore { docker run --rm -v "${PWD}:/work" -w /work ghcr.io/valqore/engine:latest valqore @args }

   复制

5. 5扫描目录

   除单文件外也可直接评估整个目录，例如仓库自带示例目录 examples/ecommerce/。

   valqore evaluate examples/ecommerce/ --score

   复制

6. 6按环境策略评估

   用 env-evaluate 指定环境（-e prod）和策略文件做评估；安全示例应返回 PASS（76/100，无严重项）。

   valqore env-evaluate examples/basics/secure-deploy.yaml -e prod --policy examples/.valqore/policy.yaml

   复制

7. 7集群安装

   用 Helm 从公开 OCI chart 安装 operator 栈，CRD 随 chart 自动安装；约 30 秒后集群出现 8 个原生 ValidatingAdmissionPolicy。

   helm install valqore oci://ghcr.io/valqore/charts/valqore-stack --namespace valqore-system --create-namespace --set 'policies[0].name=enforce-owasp-agentic' --set 'policies[0].pack=owasp_agentic' --set 'policies[0].action=Warn'

   复制

8. 8查看策略对象

   确认 enforcing 策略已在集群生效，返回该 ValqorePolicy 对象即表示安装成功。

   kubectl get valqorepolicy enforce-owasp-agentic

   复制

关键配置

如何确认成功

命令行会输出 0-100 评分与 PASS / PASS_WITH_MONITORING / BLOCK 结论；集群安装后 30 秒内集群出现 8 个 ValidatingAdmissionPolicy，且 kubectl get valq

常见问题

注意事项

• 命令中的 $PWD 是当前工作目录，请先 cd 到待扫描文件所在目录再执行，否则容器内找不到目标文件。
• 别名只在当前 shell 会话有效，重开终端需重新定义；Windows 的 PowerShell 函数同理。
• Helm 安装示例中 policy action 为 Warn，如需真正阻断（BLOCK）请据实际策略调整 action 取值。
• 官网为 https://www.valqore.io，扩展与详细文档地址为 https://docs.valqore.io。