← Back to Skills Marketplace
README Env Table Sync
by
Daniel Lummis
· GitHub ↗
· v1.0.0
271
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-env-table-sync
Description
Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI.
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-env-table-sync - After installation, invoke the skill by name or use
/readme-env-table-sync - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is README Env Table Sync?
Generate and sync a README environment-variable table from .env.example using marker blocks, with drift detection for CI. It is an AI Agent Skill for Claude Code / OpenClaw, with 271 downloads so far.
How do I install README Env Table Sync?
Run "/install readme-env-table-sync" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is README Env Table Sync free?
Yes, README Env Table Sync is completely free (open-source). You can download, install and use it at no cost.
Which platforms does README Env Table Sync support?
README Env Table Sync is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created README Env Table Sync?
It is built and maintained by Daniel Lummis (@daniellummis); the current version is v1.0.0.
More Skills