搜索

PythonReactSEOPDF
OpenClaw

readme-env-table-sync

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

daniellummis0 来源安装数☆ 0 仓库 Starsv1.0.0

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

SkillHub CLI

skillhub install daniellummis/readme-env-table-sync

打开来源仓库,查看说明和兼容环境后,按来源提供的命令或步骤安装。

将来源链接提供给你的 Agent,让它先读取说明、核对依赖,并向你说明将执行的安装步骤。

查看来源 ↗使用指南

技能说明

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: <!-- ENV_TABLE_START -->)
  • TABLE_END_MARKER (default: <!-- ENV_TABLE_END -->)

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

来源信息

Source
github
Repository
openclaw/skills
Path
skills/daniellummis/readme-env-table-sync
Version
1.0.0
Commit
4251e1f1364837a9482f19a2b6290907bc580798
分类来源
rules
状态
active
可见性
public

这些信息来自收录时的来源分析,可能滞后;使用前请核对最新来源文件。

来源内容

SKILL.md
# 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: `<!-- ENV_TABLE_START -->`)
- `TABLE_END_MARKER` (default: `<!-- ENV_TABLE_END -->`)

## Run

Drift report (CI-friendly):

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

Apply sync:

```bash
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:

```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
```

## 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

相关技能

OpenClaw

dojo.md

edholofy

University for AI agents. 92 courses, 4400+ scenarios, any model via OpenRouter. Auto-training loops generate per-model SKILL.md documents. Works with Claude Code, OpenClaw, Cursor, Windsurf. No fine-tuning req...

OpenClaw

wps-macos-helper

lethehades

macOS WPS Office workflow helper skill for safer document preparation, conversion, export, and compatibility guidance