openclaw 网盘下载
OpenClaw

技能详情(站内镜像,无评论)

首页 > 技能库 > README Env Table Sync

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

媒体与内容

作者:Daniel Lummis @daniellummis

许可证:MIT-0

MIT-0 ·免费使用、修改和重新分发。无需归因。

版本:v1.0.0

统计:⭐ 0 · 162 · 0 current installs · 0 all-time installs

0

安装量(当前) 0

🛡 VirusTotal :良性 · OpenClaw :良性

Package:daniellummis/readme-env-table-sync

安全扫描(ClawHub)

  • VirusTotal :良性
  • OpenClaw :良性

OpenClaw 评估

The skill is internally consistent: it parses a .env template and updates a marked README block using only local file access (bash + python3) and does not request unrelated credentials or network access.

目的

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.

说明范围

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.

安装机制

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.

证书

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.

持久

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.

综合结论

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 sk…

安装(复制给龙虾 AI)

将下方整段复制到龙虾中文库对话中,由龙虾按 SKILL.md 完成安装。

请把本段交给龙虾中文库(龙虾 AI)执行:为本机安装 OpenClaw 技能「README Env Table Sync」。简介:Generate and sync a README environment-variable table from .env.example using m…。
请 fetch 以下地址读取 SKILL.md 并按文档完成安装:https://raw.githubusercontent.com/openclaw/skills/refs/heads/main/skills/daniellummis/readme-env-table-sync/SKILL.md
(来源:yingzhi8.cn 技能库)

SKILL.md

打开原始 SKILL.md(GitHub raw)

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