用途:该技能为 Inkeep Agent Framework 提供添加新环境变量的规范流程,确保各包内配置具备一致性、文档说明和类型安全。\n\n主要能力:环境变量定义分布在多个 env.ts 文件中,包括 agents-api/src/env.ts(API 服务器配置)、packages/agents-core/src/env.ts(共享核心配置)和 agents-cli/src/env.ts(CLI 工具配置)。packages/agents-mcp/src/lib/env.ts 由 Speakeasy 自动生成,不应手动编辑。CI 会运行 check:env-descriptions,如果任何 env.ts 中的变量缺少 .describe() 调用就会失败,可在本地用 pnpm check:env-descriptions 检查。\n\n使用方式:添加变量时先在仓库根目录的 .env.example 中加入带描述性注释的变量,再将其加入相关 env.ts 的 Zod schema,并配上与注释一致的 .describe() 调用。根据使用位置选择文件:API 服务器配置用 agents-api/src/env.ts,跨包共享用 packages/agents-core/src/env.ts,CLI 专用用 agents-cli/src/env.ts,多包使用时加入 agents-core 并在需要处导入。schema 可选用 string、number、enum 等类型,并可按需使用 optional()、default()、min/max、refine 等校验与转换。\n\n适用场景与限制:适用于在该框架中新增或维护环境变量的开发者。必须保证 .env.example 注释与 .describe() 描述同步,敏感值应添加约束,切勿编辑自动生成文件。列表中的 Checklist 要求逐项核对并通过本地检查。
adding-env-variables
部署与运维
更新于 10-16 06:19