TopRank Skills

Home / Claw Skills / Document / readme-env-table-sync
Official OpenClaw rules 54%

readme-env-table-sync

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

Stars

0

Installs

0

Status

ACTIVE

Visibility

PUBLIC

安装方式

直接复制以下提示词,发送给你的 AI 助手即可完成安装。

请先检查是否已安装 SkillHub 商店,若未安装,请根据 https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/skillhub.md 安装 SkillHub 商店,然后安装 readme-env-table-sync 技能。 若已安装,则直接安装 readme-env-table-sync 技能。

Overview

Skill Key
daniellummis/readme-env-table-sync
Author
daniellummis
Source Repo
openclaw/skills
Version
1.0.0
Source Path
skills/daniellummis/readme-env-table-sync
Latest Commit SHA
4251e1f1364837a9482f19a2b6290907bc580798

Extracted Content

SKILL.md excerpt

# 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

Related Claw Skills

edholofy

dojo.md

★ 4

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 required.

lethehades

wps-macos-helper

★ 1

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

capt-marbles

firecrawl

★ 0

Web scraping and crawling with Firecrawl API. Fetch webpage content as markdown, take screenshots, extract structured data, search the web, and crawl documentation sites. Use when the user needs to scrape a URL, get current web info, capture a screenshot, extract specific data from pages, or crawl docs for a framework/library.

caqlayan

Tweet Processor

★ 0

Tweet Processor Skill

carev01

md-docs-search

★ 0

Full-text search across structured Markdown documentation archives using SQLite FTS5. Use when you need to search large collections of Markdown articles that are separated by "---" delimiters and contain source URLs (marked with "*Source:" pattern). Provides fast BM25-ranked search with automatic source URL extraction for citations. Ideal for research, documentation lookups, and knowledge base exploration. Requires indexing documentation first with `docs.py index`.

camelsprout

duckdb-en

★ 0

DuckDB CLI specialist for SQL analysis, data processing and file conversion. Use for SQL queries, CSV/Parquet/JSON analysis, database queries, or data conversion. Triggers on "duckdb", "sql", "query", "data analysis", "parquet", "convert data".