SuperAPI AI 工具集

env-and-config

部署与运维

查看项目

更新于 10-15 23:45

技能介绍

用途:保持环境变量与配置的文档化与一致性,确保应用在开发、预发、CI、生产等环境正确运行。适用于用户询问 .env.example、环境变量文档、需要哪些环境变量,新增需配置的服务或功能,新成员上手,搭建新环境,以及启动时校验配置并同步文档。

主要能力:一是发现,搜索代码中 process.env、os.environ、env()、配置模块与配置文件,列出每个变量名及使用位置;二是分类,区分必填与可选、默认值、适用环境,并标注机密项;三是生成或更新 .env.example,每行一个变量,含名称、占位示例与注释,使用与代码相同的名称,不含真实机密;四是编写文档,在 README 或配置文档中以表格或列表列出变量名、必填/可选、默认值、说明与用途,并从 README 链接过去;五是与校验对齐,若项目在启动时用 Zod、joi 等校验,确保 .env.example 包含全部必填变量与类型,新增变量在同一变更中同步。

约定与限制:命名用 UPPER_SNAKE,可按域加前缀如 DB_、API_、AUTH_;机密绝不写入仓库或 .env.example,仅用占位符如 your-api-key、<secret>、REPLACE_ME,并说明获取位置;有默认值时需注明;确保 .env、.env.local 及含机密文件被 .gitignore 忽略。规则要求变量必须从代码推导,不得编造未被应用读取的变量;文档需与校验 schema 一致;新增配置的变量应在同一 PR 内加入 .env.example 和文档。

交付物与检查:.env.example(含注释与占位符)、README 或配置文档、按需的校验 schema。检查清单包括:代码读取的所有变量均已列出;示例文件无真实机密且注释说明用途与必填性;文档列出变量并链接示例文件;校验 schema 与二者匹配;机密文件已在 .gitignore 中。常见反模式为编造变量、写入真实机密、缺必填/可选说明、文档与校验不同步。