返回顶部
r

readme-env-table-sync环境变量表同步

Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
252
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

readme-env-table-sync

README 环境变量表同步

使用此技能保持README环境变量文档与真实的.env.example文件同步。

此技能的功能

  • - 从.env.example(或其他环境变量模板文件)解析环境变量键
  • 生成包含键/默认值的Markdown表格
  • 通过将生成的表格与README标记块进行比较,检测文档漂移
  • 可选择直接将更新应用到README中

输入参数

可选参数:
  • - ENVFILE(默认值:.env.example)
  • READMEFILE(默认值:README.md)
  • SYNCMODE(report或apply,默认值:report)
  • TABLESTARTMARKER(默认值:
  • TABLEENDMARKER(默认值:

运行

漂移报告(适用于CI环境):

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

应用同步:

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

针对附带的测试文件运行:

bash
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

输出约定

  • - 当表格已同步(报告模式)或更新已应用(应用模式)时,退出码为0
  • 当输入无效、缺少标记、解析错误或在报告模式下检测到漂移时,退出码为1
  • 输出包含键数量和模式的简短摘要

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 readme-env-table-sync-1776204450 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 readme-env-table-sync-1776204450 技能

通过命令行安装

skillhub install readme-env-table-sync-1776204450

下载

⬇ 下载 readme-env-table-sync v1.0.0(免费)

文件大小: 2.9 KB | 发布时间: 2026-4-15 11:12

v1.0.0 最新 2026-4-15 11:12
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.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部