文档化环境变量 · Env Var Doc Generator
把项目环境变量整理成可维护文档:名称、用途、默认值与必填性逐一说明,附敏感项标记和接入指南。 Turn environment variables into maintainable documentation covering name, purpose, default, and required status, with sensitive flags and setup instructions.
$7
Works with the AI tools you already use
文档化环境变量 · Env Var Doc Generator
Example session with this skill installed
帮我把项目的环境变量整理成文档。背景:Node.js 服务,根目录有 .env.example,CI(GitHub Actions)里配了 6 个 Secrets,代码里用 process.env 读取大约 20 个变量。目标是让新同事照文档就能配好本地环境,同时标注哪些是敏感项、哪些是生产环境才需要的。不要让我贴真实密钥值。
- Read your context and instructions
- Compiled the env var doc
结论:共盘点出 22 个环境变量,其中 6 个敏感项(只记存放位置)、9 个必填、2 个疑似已失效。文档按「本地必填 → 生产/CI 专用 → 可选 → 已失效」四组组织,新同事按顺序配置即可把服务跑起来。
| 变量名 | 用途 | 类型 | 必填 | 取值环境 | 示例/说明 |
|---|---|---|---|---|---|
| PORT | HTTP 监听端口 | number | 是 | 本地+生产 | 默认 3000,生产由平台注入 |
| DATABASE_URL | PostgreSQL 连接串 | string | 是 | 本地+生产 | 生产值仅存于托管平台 Secret |
| JWT_SECRET | 登录令牌签名密钥 | secret | 是 | 本地+生产 | 生成: openssl rand -hex 32 |
| REDIS_URL | 缓存连接串 | string | 是 | 生产 | 本地缺省走内存缓存 |
| SMTP_PASSWORD | 邮件发送密码 | secret | 否 | 生产 | 仅存于 CI Secrets |
| SENTRY_DSN | 错误上报地址 | string | 否 | 生产 | 分项目申请 |
| FEATURE_FLAG_BETA | 灰度开关 | boolean | 否 | 可选 | 默认 false |
| LEGACY_API_KEY | 旧支付网关密钥 | secret | 疑似失效 | 已移除 | 代码中无读取点,建议清理 |
敏感项清单:6 个敏感变量(JWT_SECRET、SMTP_PASSWORD 等)全部「只记位置不记值」:本地放 .env.local(gitignore),CI 放 Secrets,生产放平台托管配置。
下一步
- 按文档补一份 .env.example(仅含非敏感默认值),提交团队评审。
- 把 LEGACY_API_KEY 等失效项列入清理任务,删除前再 grep 一次确认无引用。
- 让新同事按「本地必填」组配置后跑一次冒烟测试,验证文档完整。
Connects securely to your tools. The creator never sees your data.
What you get
About this skill
它解决什么问题
接手项目最怕遇到一片「黑盒」环境变量:几十个 KEY 不知道干什么用、哪些必填、哪些是敏感密钥、哪些已经没人用了。新人配环境靠口口相传,踩坑半天才起得来。这个技能把散落的 .env、CI 配置和代码读取点汇总成一份可维护的变量文档,让环境配置从「玄学」变成「照着填就行」。
这个技能做什么
围绕环境变量文档化提供结构化生成能力:先盘点项目中的 .env 文件、CI Secrets 与代码读取点,再逐个梳理名称、用途、类型、默认值、必填性与来源,输出带敏感项标记、示例值规范和接入指南的文档,并标出可能失效或重复的变量。全程只要求必要信息,缺失的标注「待确认」,真实密钥只记位置不记值。
为什么比裸提示词强
- 内嵌安全红线:敏感密钥只记录名称与存放位置,不要求、不输出明文示例值
- 按生产级标准输出:区分必填/可选、开发/生产、本地/CI 的取值差异
- 结论先行:先给盘点结论与风险清单,再给完整变量表,一眼看到重点
- 专注文档化:不改变量、不动配置,与「迁移」类技能互补而不重复
典型用例
- 新成员入职,需要一份环境变量速查表才能把服务跑起来
- 安全审计前,需要清点所有敏感变量及其存放位置
- 接手遗留项目,先弄清哪些变量在用、哪些已经失效
- 上线新环境前,生成一份环境差异对照表防止漏配
局限
技能输出的是文档与清单,不直接修改 .env 或 CI 配置;涉及真实密钥的核对,请在有权限的安全环境中进行,不要把真实密钥粘贴到对话里。
还有How to install
Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.
- 1
Download the ZIP
Free skills download straight away. Paid skills unlock right after purchase.
- 2
Unzip into your skills folder
Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.
- 3
Ask your agent to use it
Restart the agent if it was already running. It picks the skill up automatically - no config needed.
Skills folder by agent
Click the path to copy it. Create the folder if it does not exist yet.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
Fresh listing
Recently published to Agensi
30-day refund
Not a fit? Get your money back
Trust & safety
Security scanned
Verified clean today
- Passed all security checks, Safe to install