update-readme — Claude Code command: README updates
update-readme — a command for Claude Code and Codex rebuilds the plugin sections in README.md. It reads the plugin folders and marketplace data.
Apache-2.0 ★ 1,216 updated 2026-11-09
/plugin marketplace add fcakyon/claude-codex-settings
/plugin install claude-tools@claude-settingsWhat update-readme does
The command reads .claude-plugin/marketplace.json, scans plugin folders, then refreshes the Plugins section in README.md. The generated blocks can list descriptions, install instructions, skills, commands, agents, hooks, and MCP servers when present.
It also updates the Installation section if plugin names have changed. For Cursor, it documents the interactive flow through cursor-agent and /plugin; it does not invent a direct install command. Sections outside the plugin and Installation content remain untouched.
In Claude Code, add the marketplace first and then install claude-tools. The Codex prompt file goes at ~/.codex/prompts/update-readme.md.
What it helps with
- rebuild the README plugin list from marketplace metadata
- refresh plugin descriptions and links to skills and commands
- document installation options for the plugins in a repository
- leave README sections outside plugin content unchanged
Example prompts for the agent
- Refresh the Plugins section in
README.mdfrom the current plugin folders. - Compare the plugin install details with
.claude-plugin/marketplace.jsonand update the README. - Update the plugin blocks in
README.mdwithout changing Configuration or TODO.
How to install update-readme
1Plugin marketplace
/plugin marketplace add fcakyon/claude-codex-settings/plugin install claude-tools@claude-settings2Manually: put the files in place
.claude/commands/update-readme.mdCall it with /update-readme. For all projects use ~/.claude/commands/
Manually: put the files in place
~/.codex/prompts/update-readme.mdCall it with /prompts:update-readme. Codex marks this format deprecated in favour of skills
Manually: put the files in place
.github/prompts/update-readme.prompt.mdManually: put the files in place
.gemini/commands/update-readme.tomlGemini stores commands as TOML: the prompt text goes into the prompt field
Questions about update-readme
How do I install update-readme in Claude Code?
Add the marketplace with /plugin marketplace add fcakyon/claude-codex-settings, then install the plugin with /plugin install claude-tools@claude-settings. The command file is .claude/commands/update-readme.md.
What does update-readme do?
It rebuilds the plugin content in README.md using marketplace metadata and the plugin directory structure. It can also revise Installation when plugin names change.
Does update-readme edit README sections outside the plugins?
No. It leaves sections such as Configuration, Statusline, TODO, References, and Star History unchanged.
Source text
update-readme.md · Apache-2.0
--- allowed-tools: Read, Glob, Grep, Edit description: Update README.md plugin sections and download links --- # Update README.md Regenerate the Plugins section of README.md based on current plugin structure and marketplace data. ## Steps 1. Read `.claude-plugin/marketplace.json` to get the full list of plugins with descriptions, versions, and metadata. 2. For each plugin, scan `plugins/<name>/` to discover: - Skills: `plugins/<name>/skills/*/SKILL.md` - Commands: `plugins/<name>/commands/*.md` - Agents: use `.claude-plugin/plugin.json` `agents` paths when set, otherwise `plugins/<name>/agents/*.md` - Hooks: use `.claude-plugin/plugin.json` `hooks` paths when set, otherwise `plugins/<name>/hooks/hooks.json` - MCP: `plugins/<name>/.mcp.json` - Antigravity: include its install command only when `.antigravity-plugin/plugin.json` exists; the installer packages skills and MCP servers, not Claude hooks or agents 3. Update each plugin's `<details>` block in README.md. Use this format: ````markdown <details> <summary><strong>plugin-name</strong> - Short description</summary> | Claude Code | Codex CLI | Cursor | Antigravity CLI | | --------------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `claude plugin install plugin-name@claude-settings` | `codex plugin add plugin-name@claude-settings` | Run `cursor-agent`, enter `/plugin`, and install by name | `uv run .github/scripts/antigravity.py install plugin-name` | **Skills CLI** ```bash npx skills add https://github.com/fcakyon/claude-codex-settings/tree/main/plugins/plugin-name --skill '*' ``` One-line description. **Skills:** - [`skill-name`](./plugins/plugin-name/skills/skill-name/SKILL.md) - Description from SKILL.md frontmatter **Commands:** (if any) - [`/plugin-name:cmd`](./plugins/plugin-name/commands/cmd.md) - Description from frontmatter **Agents:** / **Hooks:** / **MCP:** (if applicable) </details> ```` 4. Only add the `Skills CLI` block when `plugins/<name>/skills/*/SKILL.md` exists. - For plugins without local skills, omit the `Skills CLI` block. - Do not add a global `Skills CLI` section under `## Installation`. - Do not add `--list`. - Do not add per-skill `npx skills add` commands. - Do not add a `Skills CLI` column to skill tables. - Do not mention maintainer sync scripts. The Antigravity installer is user-facing and belongs in its supported-tool column. - Do not link to `skills.sh`. 5. For skill-only plugins (no MCP, no commands), use a table with ZIP download badges: ```markdown **Skills** (ZIP for claude.ai, Claude Code, Cursor, Codex, VS Code): | Skill | Description | ZIP | | ---------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`skill-name`](./plugins/plugin-name/skills/skill-name/SKILL.md) | Description | [](https://github.com/fcakyon/claude-codex-settings/releases/latest/download/skill-name.zip) | ``` 6. Also update the Installation section if plugin names have changed. - Cursor installation is interactive. Do not invent a direct Cursor install command. - Add the marketplace with `cursor-agent plugin marketplace add https://github.com/fcakyon/claude-codex-settings`, then tell the reader to run `cursor-agent` and enter `/plugin`. 7. Do NOT modify non-plugin sections (header, Configuration, Statusline, TODO, References, Star History).
© Fatih C. Akyon · Apache-2.0 · fcakyon/claude-codex-settings