Skip to content
Get packs

EGM Bootstrap README Generator

Generates and checks README contract docs across a repository folder tree

Source Download skill
Repository
google/elephant-goldfish-model
Stars
9,965
Licence
Apache-2.0
Files
4 files

What it does

This skill tells an AI agent how to walk through a code repository folder by folder and write or update README.md files that describe each component's file contracts, interfaces, and side effects, rolling them up into parent-level index documents. It is aimed at teams using the Elephant-and-Goldfish Model documentation format. It restricts the agent to documentation work: it should not change functional source code, make git commits, or touch files outside the documentation it generates.

Great for

  • Developers maintaining a large monorepo who want consistent per-package README contracts
  • Teams adopting the Elephant-and-Goldfish Model documentation format
  • Engineers who want an agent to detect the test command for each package and record it in the docs

Skip it if

  • Small projects with a handful of folders, where writing READMEs by hand is faster and avoids large automated edits
  • Repositories with hand-written READMEs you do not want changed; the skill can overwrite README.md unless an alternate filename such as EGM.md is chosen, so review changes first
  • Users who are not working in a code repository, since the workflow assumes source files, manifests, and test commands

Try asking

  • “Bootstrap EGM README contracts for the src/ directory of this repository”
  • “Generate Hay-level blueprint indexes for the packages under services/”
  • “Write EGM.md files instead of README.md so existing human-maintained READMEs stay untouched”
  • “Check which test commands apply to each package and record them in the generated docs”
Step-by-step guide: how to use EGM Bootstrap README GeneratorInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 4 original files, the Apache-2.0 licence and an attribution note.

    egm-bootstrap.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip egm-bootstrap.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip egm-bootstrap.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Review the discovery map and the list of directories before approving full-tree execution, since the skill pauses above 15 subdirectories and asks for confirmation.
  • Use target_filename set to EGM.md when existing README files must not be modified.
  • Commit or stash your work before running, then review the generated diffs yourself, because the skill deliberately leaves git commits to you.

What's inside

  • agents/openai.yaml
  • references/templates.md
  • references/worker-return.schema.json
  • SKILL.md

Redistributed unmodified from google/elephant-goldfish-model under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-11-02. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.