README Env Table Sync

解析 .env.example 生成 Markdown 环境变量表，通过标记块写入或比对 README，检测文档漂移；report 模式检测到漂移时退出码为 1，apply 模式直接更新 README。依赖 bash 与 python3，不访问网络。

daniellummis

热度 51.65

最近更新 2026-05-11 17:28:58

分类：效率依赖：代码执行 / 读写文件应用场景：工作流 / 自动化脚本 / 文件转换

安装技能

复制下面的话术发给你的 Agent，它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill： npx secure-skills-cli add readme-env-table-sync

Metadata

name: readme-env-table-sync
description: Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI.
version: 1.0.0
metadata: {"openclaw":{"requires":{"bins":["bash","python3"]}}}

README Env Table Sync

Use this skill to keep README environment-variable docs aligned with the real .env.example file.

What this skill does

Parses env keys from .env.example (or another env template file)
Generates a markdown table with key/default values
Detects doc drift by comparing generated table with the README marker block
Optionally applies the update directly into README

Inputs

Optional:

ENV_FILE (default: .env.example)
README_FILE (default: README.md)
SYNC_MODE (report or apply, default: report)
TABLE_START_MARKER (default: )
TABLE_END_MARKER (default: )

Run

Drift report (CI-friendly):

ENV_FILE=.env.example \
README_FILE=README.md \
bash skills/readme-env-table-sync/scripts/sync-readme-env-table.sh

Apply sync:

ENV_FILE=.env.example \
README_FILE=README.md \
SYNC_MODE=apply \
bash skills/readme-env-table-sync/scripts/sync-readme-env-table.sh

Run against included fixtures:

ENV_FILE=skills/readme-env-table-sync/fixtures/.env.sample \
README_FILE=skills/readme-env-table-sync/fixtures/README.sample.md \
SYNC_MODE=apply \
bash skills/readme-env-table-sync/scripts/sync-readme-env-table.sh

Output contract

Exit 0 when table is already in sync (report) or update is applied (apply)
Exit 1 on invalid inputs, missing markers, parse errors, or detected drift in report mode
Prints a short summary with key count and mode