EGM 부트스트랩 (README 계약 문서 자동 생성)
저장소 디렉터리 트리를 훑어 인터페이스·불변식·부작용을 명시한 EGM 규약 README.md를 자동으로 생성·보정합니다.
개발·코딩고급★ 5,282⑂ 316AI 점수 7/10마지막 업데이트: 2026. 10. 29.
무엇을 해주나
- 지정한 경로 아래 디렉터리 트리를 한 단계씩(BFS) 탐색하면서 코드가 있는 디렉터리만 선별합니다(테스트 전용·빌드 산출물·
node_modules등은 제외). - 각 디렉터리를 Peanut(실제 소스가 있는 컴포넌트 패키지) 과 Hay(하위 계약을 모으는 상위 청사진) 로 분류해 각기 다른 README 템플릿을 적용합니다.
- 읽기 전용 정찰 서브에이전트(
goldfish-explorer)가 소스를 읽어 Interface / Invariants / Side Effects 를 추출하고, 모든 항목에[파일:심볼]근거를 달아 추측성 서술을 차단합니다. - 기존 README가 있으면 통째로 덮어쓰지 않고 개발자 메모를 보존한 채 EGM 형식으로 보정합니다. (
target_filename을EGM.md등으로 바꿔 기존 문서를 건드리지 않게 할 수도 있습니다.) package.json,Cargo.toml,go.mod,pyproject.toml,Makefile,BUILD를 감지해 각 문서에 맞는 검증 명령(npm test,cargo test,bazel test //pkg/...등)을 채웁니다.- 마지막에 생성·수정한 모든 문서를 다시 읽어 링크 유효성, 마크다운 문법, 코드 근거를 검증합니다.
제약: 기능 코드 작성·리팩터링 금지,
git add/git commit금지, 디렉터리 15개 초과 시 사용자 승인 필수.
이런 분께 추천
- 문서가 없거나 낡은 중·대형 모노레포를 정리해야 하는 개발자·테크리드
- AI 코딩 도구가 코드베이스 구조를 빠르게 파악하도록 "계약 문서" 레이어를 깔고 싶은 팀
- 아키텍처 경계(인터페이스·불변식·부작용)를 문서로 강제하고 싶은 플랫폼/인프라 팀
활용 예시
path=services/payments로 실행 → 결제 서비스 하위 각 패키지에 인터페이스와 부작용이 명시된 README가 생성되고, 루트에는 하위 모듈 인덱스 청사진이 만들어집니다.- 이미 사람이 관리하는 README가 있는 저장소에서
target_filename=EGM.md로 실행 → 기존 문서는 그대로 두고 별도의 계약 파일만 생성합니다. - 디렉터리가 60개인 모노레포에서 실행 → 안전 게이트가 작동해 전체 실행 승인을 물은 뒤, 서브트리별 병렬 워커를 띄워 문서화하고 루트에서 결과를 취합합니다.
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/google/elephant-goldfish-model/HEAD/distributions/claude/skills/egm-bootstrap/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
AI 스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 google/elephant-goldfish-model 의 distributions/claude/skills/egm-bootstrap 폴더를 내 ~/.claude/skills/egm-bootstrap/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
git clone https://github.com/google/elephant-goldfish-model.git && mkdir -p ~/.claude/skills && cp -r elephant-goldfish-model/distributions/claude/skills/egm-bootstrap ~/.claude/skills/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 엽니다.
- 저장소를 내려받습니다:
git clone https://github.com/google/elephant-goldfish-model.git - 스킬 폴더를 만듭니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다:
cp -r elephant-goldfish-model/distributions/claude/skills/egm-bootstrap ~/.claude/skills/ agents/,references/,docs/하위 파일이 함께 복사됐는지 확인합니다(템플릿과 워커 스키마가 필요합니다).- Claude Code를 재시작한 뒤
/skills또는 스킬 목록에서egm-bootstrap이 보이는지 확인합니다. - 사용할 때는 "egm-bootstrap 스킬로
src/디렉터리를 문서화해줘" 처럼 대상 경로를 명시해 직접 호출합니다(모델 자동 호출은 꺼져 있습니다). - 처음에는 작은 하위 폴더로 시험하고, 결과는
git diff로 검토한 뒤 직접 커밋하세요.
GitHub에서 원본 보기 ↗라이선스: Apache-2.0