Skip to content

commandDocumentation

Update README

Compares your README with the real code and fixes install, run and usage sections that no longer match what the project does.

npx workspacetemplates add update-readme --tool claude-code

Writes 1 file to .claude/commands/

.claude/commands/update-readme.md14 lines · 1.2 KBFile
---
description: Compares your README with the real code and fixes install, run and usage sections that no longer match what the project does.
argument-hint: "[section to focus on, optional]"
---

Update the README so it matches the code. Focus from the user: $ARGUMENTS

1. Read the README and list each factual claim: prerequisites and versions, install commands, run and build scripts, configuration, example code, ports, and links.
2. Verify each against the project: scripts in the manifest or Makefile, version files, environment variable names in code, CLI flags in the argument parser, and whether linked files inside the repository exist. Run commands only if they are safe and read-only, such as `--help` or `--version`.
3. Fix wrong statements, delete sections for features that no longer exist, and add missing steps a new user would hit: a required tool, an env file to copy, a first-run command.
4. Keep the existing headings, voice and formatting. Do not add badges, marketing text or a table of contents unless one already exists.
5. Keep code blocks runnable: copy command names exactly.

Show the changes as a diff with a one-line reason for each edit, plus anything you could not verify. Ask before saving the file.

What it does

READMEs rot quietly: a renamed script, a new required tool, an option that was removed last spring. This command checks every claim in the file against the project and corrects the ones that are wrong.

Where the README is silent, it adds only what a new user needs to get started. Your tone and structure stay, and the diff is shown before anything is saved.

Example

you › /update-readme installation and usage

agent › 6 edits: Node 18 changed to 20 (see .nvmrc), "npm start" is now "npm run dev", removed the --legacy flag docs (flag gone since v2), added copying .env.example. Not verified: the Docker badge URL. Save the README?

Questions

Will it rewrite my whole README?
No. It keeps your structure and wording and changes only statements that are wrong or missing.
Does it run my install commands?
Only safe, read-only ones like version checks. Anything that installs or builds is left for you.
  • Document Function

    CommandDocumentation

    Free
  • Explain Error

    CommandDocumentation

    Free
  • Generate API Docs

    CommandDocumentation

    Free
  • Repository Code Tour

    CommandDocumentation

    Free