← 返回 Skills 市场
README Env Table Sync
作者
Daniel Lummis
· GitHub ↗
· v1.0.0
271
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-env-table-sync
功能描述
Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI.
安全使用建议
This script is straightforward: it reads the env template and README you point it at and will overwrite the README block between your start/end markers when run with SYNC_MODE=apply. Before using apply in a repository, ensure you run it from the repo root (or set ENV_FILE/README_FILE to the correct paths), verify the markers exist, and review changes (e.g., via git diff) before committing. No network or credential access is performed by the skill; the main risk is accidental overwriting of README content if markers are mis-specified—keep backups or use version control to revert if needed.
功能分析
Type: OpenClaw Skill
Name: readme-env-table-sync
Version: 1.0.0
The skill is a utility for synchronizing environment variable documentation between a template file (like .env.example) and a README.md file. The implementation in scripts/sync-readme-env-table.sh uses a Python script to parse keys, detect drift, and update the README within specified marker blocks; it contains no network calls, obfuscation, or evidence of malicious intent.
能力评估
Purpose & Capability
Name/description match the included script and SKILL.md: the tool only needs bash and python3 to parse an env template and update a README marker block. Nothing requested or included (no extra binaries, no credentials) is out of scope for this purpose.
Instruction Scope
Runtime instructions and the embedded Python script only read the specified ENV_FILE and README_FILE, compare/generate a markdown table, and optionally overwrite the README between provided markers. No other files, environment secrets, or network endpoints are accessed.
Install Mechanism
Instruction-only skill with no install spec and one bundled script; nothing is downloaded or installed. This is low-risk and proportional for the task.
Credentials
No required environment variables, credentials, or config paths are declared. The optional runtime variables (ENV_FILE, README_FILE, SYNC_MODE, markers) are appropriate and sufficient for operation.
Persistence & Privilege
Skill does not request always:true or any persistent/system-wide privileges. It will only modify the README file when run with SYNC_MODE=apply, which is expected behavior for a sync tool.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-env-table-sync - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-env-table-sync触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
Initial release of readme-env-table-sync.
- Generates and synchronizes a markdown environment-variable table in README from a `.env.example` file.
- Detects and reports drift between the README environment table and `.env.example` for CI/CD.
- Optionally updates the README file automatically.
- Supports customizable file paths, marker blocks, and sync mode.
- Returns descriptive exit codes and summaries for integration and automation.
元数据
常见问题
README Env Table Sync 是什么？
Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 271 次。
如何安装 README Env Table Sync？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-env-table-sync」即可一键安装，无需额外配置。
README Env Table Sync 是免费的吗？
是的，README Env Table Sync 完全免费（开源免费），可自由下载、安装和使用。
README Env Table Sync 支持哪些平台？
README Env Table Sync 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 README Env Table Sync？
由 Daniel Lummis（@daniellummis）开发并维护，当前版本 v1.0.0。
推荐 Skills