An automated utility to synchronize environment variable tables in your README with .env.example files to prevent documentation drift.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install readme-env-table-sync
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install readme-env-table-sync using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Readme Env Table Sync?
Readme Env Table Sync is a specialized utility designed to bridge the gap between project configuration and documentation. By automatically parsing environment variable keys and default values from files like .env.example, it generates and maintains a structured Markdown table within your README. This ensures that your documentation remains accurate and up-to-date, which is a core benefit for developers managing complex Openclaw Skills environments.
This skill is particularly effective for teams that prioritize documentation-as-code. It utilizes a marker-based injection system, allowing it to target specific sections of a Markdown file without disturbing other content. Whether used as a local helper or integrated into a build pipeline, it provides a reliable way to verify that your environment setup instructions are never out of sync with your actual codebase.
Readme Env Table Sync Use Cases
- Automatically generating comprehensive environment variable tables for project onboarding.
- Implementing CI/CD checks to prevent documentation drift before code is merged.
- Maintaining consistent documentation across multiple microservices or Openclaw Skills repositories.
- Synchronizing configuration templates with README files in open-source projects.
How Readme Env Table Sync Works
- The skill identifies the source template file (e.g., .env.example) and the target Markdown file.
- It extracts environment variable keys and any associated default values through a parsing script.
- A Markdown-formatted table is dynamically generated from the extracted data.
- The tool scans the target README for specific start and end marker comments.
- Depending on the configuration, it either reports a mismatch (drift detection) or updates the table directly between the markers.
Readme Env Table Sync Setup
To use this tool within your Openclaw Skills workflow, ensure your environment has bash and python3 available. Execute the sync script using the following command structure:
ENV_FILE=.env.example \
README_FILE=README.md \
SYNC_MODE=apply \
bash skills/readme-env-table-sync/scripts/sync-readme-env-table.sh
Readme Env Table Sync Data Schema & Taxonomy
The skill relies on specific environment variables for configuration and targets Markdown files with predefined HTML comment markers.
| Variable | Purpose | Default Value |
|---|---|---|
ENV_FILE |
Path to the environment template source. | .env.example |
README_FILE |
Path to the Markdown file to update. | README.md |
SYNC_MODE |
Operation mode: report (check) or apply (write). | report |
TABLE_START_MARKER |
Opening marker for the injection zone. | <!-- ENV_TABLE_START --> |
TABLE_END_MARKER |
Closing marker for the injection zone. | <!-- ENV_TABLE_END --> |
Readme Env Table Sync Advanced Features
- CI-ready drift detection that returns a non-zero exit code if documentation is outdated.
- Flexible marker support allowing for multiple environment tables in a single document.
- Support for custom file paths, making it adaptable to various project structures and Openclaw Skills configurations.
- Minimal dependency footprint, requiring only standard bash and python3 environments.
SKILL.md
Loading
Related Openclaw Skills
Prisma Migrate Guard
A pre-deployment health check tool for Prisma migrations that prevents broken database states in production.
JUnit Failure Fingerprint
Cluster noisy JUnit test failures into stable, repeatable fingerprints to streamline CI triage and identify root causes.
GitHub Actions Workflow Hardening Audit
A static analysis tool to identify security hardening gaps in GitHub Actions workflow files before they reach production.
GitHub Actions Trigger Health Audit
A diagnostic tool for identifying flaky GitHub Actions workflows by analyzing failure rates across specific trigger events and repositories.
Render Deploy Diff
A pre-deployment utility that detects environment variable drift between local configurations and live Render services to prevent failed builds.
Render Env Guard
A preflight-check utility for Render services that prevents deployment failures by validating environment variables and catching placeholder values.
Featured*
