How do I install the Update Readme skill?

Run npx skillmds@latest add comet-ml/update-readme 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 Update Readme 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 Update Readme?

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 Update Readme free to use?

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

Who published Update Readme?

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

Update Readme by comet-ml — Agent Skill

Name: Update Readme
Author: comet-ml

Update Readme

Regenerate the auto-generated sections of README.md (project tree, common-tasks table) to reflect the current state of pyproject.toml, the Makefile, and src/. Use when project structure changes, deps change, or those sections drift from reality. Preserves any user-authored prose outside the AUTO-GENERATED markers.

comet-ml c06aa27 2.5 KB Updated Sep 17, 2026

File contents

Update README

Regenerate the auto-generated sections of README.md so they reflect what's actually in the repo.

What is auto-generated

The README has marker pairs like:

<!-- AUTO-GENERATED:tree -->
... content ...
<!-- /AUTO-GENERATED:tree -->

Everything inside the marker pair is owned by this skill and will be replaced. Everything outside is user-authored — preserve it verbatim.

Sections currently under marker control:

AUTO-GENERATED:tree — the project layout tree
AUTO-GENERATED:tasks (if present) — the common-tasks table

Procedure

Inspect current state:
- List the top-level directories with ls -la (filter out .git, .venv, __pycache__).
- List src/<module>/ contents.
- Parse pyproject.toml for dependencies and optional-dependencies.
- Parse Makefile .PHONY targets.
Rebuild the tree as ASCII inside the AUTO-GENERATED:tree block. Skip:
- dot-directories except .claude/
- __pycache__, .venv, .ruff_cache, .pytest_cache
- files under data/, models/, reports/figures/ (just show the folder)
Rebuild the common-tasks table (if the AUTO-GENERATED:tasks block exists) from the Makefile's .PHONY targets. Map each target to a one-line description from the help target if present.
Edit README.md in place. Touch nothing outside the marker pairs.
Diff check: git diff README.md. If anything outside a marker block changed, revert and report the bug — the marker logic is broken.
Stage: tell the user to review and git add README.md. Do not auto-stage.

Adding a new auto-generated section

If the user asks for a new section to be machine-managed:

Pick a stable marker name (kebab-case): AUTO-GENERATED:deps.
Insert the marker pair into README.md in the right place with placeholder content.
Extend this skill: add a "Procedure" step for the new section.

Anti-patterns

Rewriting the whole README — touches user prose. Stick to marker blocks.
Adding emojis or marketing copy. The README documents what exists.
Drifting from the layout actually present on disk (e.g., listing notebooks/ if it's been deleted).

---name: update-readmedescription: Regenerate the auto-generated sections of README.md (project tree, common-tasks table) to reflect the current state of pyproject.toml, the Makefile, and src/. Use when project structure changes, deps change, or those sections drift from reality. Preserves any user-authored prose outside the AUTO-GENERATED markers.---# Update READMERegenerate the auto-generated sections of `README.md` so they reflect what's actually in the repo.## What is auto-generatedThe README has marker pairs like:```markdown... content ...```Everything **inside** the marker pair is owned by this skill and will be replaced. Everything **outside** is user-authored — preserve it verbatim.Sections currently under marker control:- `AUTO-GENERATED:tree` — the project layout tree- `AUTO-GENERATED:tasks` (if present) — the common-tasks table## Procedure1. **Inspect current state**: - List the top-level directories with `ls -la` (filter out `.git`, `.venv`, `__pycache__`). - List `src/<module>/` contents. - Parse `pyproject.toml` for `dependencies` and `optional-dependencies`. - Parse `Makefile` `.PHONY` targets.2. **Rebuild the tree** as ASCII inside the `AUTO-GENERATED:tree` block. Skip: - dot-directories except `.claude/` - `__pycache__`, `.venv`, `.ruff_cache`, `.pytest_cache` - files under `data/`, `models/`, `reports/figures/` (just show the folder)3. **Rebuild the common-tasks table** (if the `AUTO-GENERATED:tasks` block exists) from the Makefile's `.PHONY` targets. Map each target to a one-line description from the `help` target if present.4. **Edit** `README.md` in place. Touch nothing outside the marker pairs.5. **Diff check**: `git diff README.md`. If anything outside a marker block changed, revert and report the bug — the marker logic is broken.6. **Stage**: tell the user to review and `git add README.md`. Do **not** auto-stage.## Adding a new auto-generated sectionIf the user asks for a new section to be machine-managed:1. Pick a stable marker name (kebab-case): `AUTO-GENERATED:deps`.2. Insert the marker pair into `README.md` in the right place with placeholder content.3. Extend this skill: add a "Procedure" step for the new section.## Anti-patterns- Rewriting the whole README — touches user prose. Stick to marker blocks.- Adding emojis or marketing copy. The README documents what exists.- Drifting from the layout actually present on disk (e.g., listing `notebooks/` if it's been deleted).

Frequently asked questions