How do I install the Workflow Image Readme Sync skill?

Run npx skillmds@latest add tomevault-io/workflow-image-readme-sync in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Workflow Image Readme Sync safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Workflow Image Readme Sync?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Workflow Image Readme Sync free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Workflow Image Readme Sync?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Workflow Image Readme Sync by tomevault-io

Name: Workflow Image Readme Sync
Author: tomevault-io

Workflow Image Readme Sync

Scan .github/workflows for Docker images built and pushed by this repository, then update the README.md image table with the discovered images, base images, build contexts, workflow paths, and concise agent-written descriptions based on each build context. Use this when asked to sync repository Docker image documentation from GitHub Actions workflows. Use when this capability is needed.

tomevault-io 9efeb68 2 files · 3.1 KB Updated Sep 17, 2026

File contents

Workflow Image README Sync

Use this skill when the user wants README.md updated from Docker image definitions in .github/workflows.

Workflow

Run python3 scripts/update_readme.py --print-discovery-json to discover images, base images, build contexts, and workflow paths.
Read each discovered build context, starting with its Dockerfile and only the nearby files needed to understand the image's purpose.
Write concise human descriptions in the style of product summaries, not low-level Dockerfile narration.
Save the descriptions in a JSON mapping from image name to description, then run python3 scripts/update_readme.py --description-file <file>.
Check the updated table in README.md and verify each row includes Image, Base Image, Context, a Workflow badge that links to the GitHub Actions workflow, and Description.

Notes

The updater rewrites only the content between the  and  markers in README.md.
The Python script is intentionally data-oriented. It discovers image metadata and renders the table, but the agent is responsible for the final description quality.
The repository-level scripts for this workflow live in ../../../scripts. Prefer ../../../scripts/update_readme.py and ../../../scripts/generate_readme_image_descriptions.py.
The Workflow column should render GitHub Actions badge images that link to each workflow page, rather than plain text workflow paths.
Prefer short summaries like Debian base image with custom ca certs or Vault running in agent mode with config templating.
If no images are found, the table is populated with a single None row so the README stays explicit.

Source: evindunn/docker — distributed by TomeVault.

---name: workflow-image-readme-syncdescription: Scan .github/workflows for Docker images built and pushed by this repository, then update the README.md image table with the discovered images, base images, build contexts, workflow paths, and concise agent-written descriptions based on each build context. Use this when asked to sync repository Docker image documentation from GitHub Actions workflows. Use when this capability is needed.---# Workflow Image README SyncUse this skill when the user wants `README.md` updated from Docker image definitions in [`.github/workflows`](../../../.github/workflows).## Workflow1. Run `python3 scripts/update_readme.py --print-discovery-json` to discover images, base images, build contexts, and workflow paths.2. Read each discovered build context, starting with its `Dockerfile` and only the nearby files needed to understand the image's purpose.3. Write concise human descriptions in the style of product summaries, not low-level Dockerfile narration.4. Save the descriptions in a JSON mapping from image name to description, then run `python3 scripts/update_readme.py --description-file <file>`.5. Check the updated table in [`README.md`](../../../README.md) and verify each row includes `Image`, `Base Image`, `Context`, a `Workflow` badge that links to the GitHub Actions workflow, and `Description`.## Notes- The updater rewrites only the content between the `` and `` markers in [`README.md`](../../../README.md).- The Python script is intentionally data-oriented. It discovers image metadata and renders the table, but the agent is responsible for the final description quality.- The repository-level scripts for this workflow live in [`../../../scripts`](../../../scripts). Prefer [`../../../scripts/update_readme.py`](../../../scripts/update_readme.py) and [`../../../scripts/generate_readme_image_descriptions.py`](../../../scripts/generate_readme_image_descriptions.py).- The `Workflow` column should render GitHub Actions badge images that link to each workflow page, rather than plain text workflow paths.- Prefer short summaries like `Debian base image with custom ca certs` or `Vault running in agent mode with config templating`.- If no images are found, the table is populated with a single `None` row so the README stays explicit.---> Source: [evindunn/docker](https://github.com/evindunn/docker) — distributed by [TomeVault](https://tomevault.io).

Frequently asked questions