elephant-goldfish-model README

README проекта с github.com/google/elephant-goldfish-model. Одним файлом markdown: README.md.

Elephant-Goldfish Model

Design with an elephant. Review with a goldfish.

Install  ·  Quickstart  ·  Documentation  ·  Website


Develop ideas with context and review documents with fresh eyes. EGM is an open-source plugin for AI assistants.

Elephant holds your project context and drafts the specification. Goldfish reviewers examine the draft and referenced source material without the earlier conversation, helping expose unstated assumptions and blind spots. You make the architectural trade-offs and approve the specification before implementing.

The built-in draft and design-review workflow targets software specifications. For other documents, choose reviewers and standards with /egm-review-loop. Bootstrap and drift reporting apply to software codebases.

https://github.com/user-attachments/assets/93c799a2-10a3-4266-af02-eb79dd33a9a2

Install

Choose your coding agent. Install the complete plugin so its skills can read the reviewer prompts and document standards.

ChatGPT and Codex desktop

Open the published EGM plugin in the desktop app and install it. This listing is desktop-only. For Codex CLI, use the commands below.

Antigravity CLI

agy plugin install https://github.com/google/elephant-goldfish-model

For the Antigravity App and Antigravity for IDEs (Visual Studio Code extension), run /plugin or see the installation instructions.

Claude Code

claude plugin marketplace add google/elephant-goldfish-model
claude plugin install egm@egm

Codex CLI

codex plugin marketplace add google/elephant-goldfish-model
codex plugin add egm@egm

Start a new session after installation. For Claude Cowork and ChatGPT Work, see the setup guide.

Try a 60-second review on existing code

Review an existing design document, README, or PR plan against the live code. You do not need to write a new specification. The commands below use the /egm: prefix for Antigravity (agy CLI) and Claude Code. In Codex, select the corresponding EGM skill from the skill picker.

Review an existing document

/egm:egm-review docs/designs/webhooks.md

Use the path to your design doc, or to a PR plan saved as Markdown. Fresh reviewers check the design, its clarity, its fit with the code, and its implementation plan.

Check for drift

/egm:egm-drift-report docs/designs/

The agent compares each document in the folder with the current source code and reports where they diverge. You decide whether to update the document or the code.

Try your first design

Open your project in your coding agent and choose a feature that needs design decisions. This example adds webhook delivery: what should happen when a delivery fails, or the same event arrives twice?

The commands below are shown without a prefix. In Antigravity (agy CLI) and Claude Code, add the /egm: prefix, for example /egm:egm-brainstorm. On agy CLI 1.4.10 an unprefixed name is completed to the prefixed command (#220), but 1.4.8 does not (#196), so keep the prefix. In Codex, select the corresponding EGM skill from the skill picker. Brainstorming and review require a session that can create fresh subagents.

Explore the idea

/egm-brainstorm Add webhook delivery to this project.

Discuss requirements and trade-offs with the agent. Fresh reviewers challenge the proposal, and the agent saves the agreed direction in concepts_brief.md.

Draft the specification

/egm-draft

The agent turns the brief into design_draft.md, pausing after each section for your feedback in chat.

Review the draft

/egm-review design_draft.md

Use the draft path returned by the agent.

Fresh reviewers check the design, its clarity, its fit with the code, and its implementation plan. Choose which findings to address. When you approve the design, ask your coding agent to implement it.

See the workflow guide for the full process, including saving approved specifications under docs/designs/.

How it works

RoleContextResponsibility
ElephantYour project, requirements, and earlier decisionsExplore the problem and draft the specification.
GoldfishThe document and its referenced source material, without the earlier conversationFind missing assumptions, unclear requirements, and implementation risks.
YouThe goals and constraints that matterResolve trade-offs, approve the design, and decide what to build.

Goldfish reviews require fresh subagent contexts. If your agent cannot create them, EGM stops the review. A review does not replace tests or human judgment. See supported environments and verification limits.

Choose a skill

You can use each skill when you need it. You do not have to follow the full sequence.

SkillUse it to…
 BrainstormTest an idea and write a concept brief.
 DraftTurn a brief or existing notes into a design document.
 ResolveWork through review findings and agree on changes.
 BootstrapCreate or update documentation for an existing codebase.
 LiteFast-track small iterations, spec revisions, refactors, and bug fixes.
 ReviewReview a design with fresh agents across five stages.
 Review loopRun a configured group of reviewers for a specific review task.
 Drift reportCompare checked-in documents with the current source code.

Learn more

Contribute

See the accessibility statement for accessibility goals, known limits, and how to report barriers.

Read contributing for PRs, issues for bugs, and discussions for questions.

License

Apache 2.0. This is not an officially supported Google product.

elephant-goldfish-model (google/elephant-goldfish-model)

Ищем в базе…

Что это такое?EGM — это плагин с открытым исходным кодом, в котором есть набор навыков. Они помогают составить спецификацию ПО с помощью ИИ-агента с глубоким контекстом, а затем проверить её с помощью субагентов-рецензентов без контекста, прежде чем писать код.
Это отдельное приложение или оно подключается к моему агенту для программирования?Это плагин, который устанавливается в уже существующего агента для программирования (Antigravity, Claude Code или Codex). Он добавляет навыки, которыми пользуется агент, сам по себе он не работает.
Как его установить и начать пользоваться?Выберите агента для программирования (Antigravity, Claude Code или Codex), установите полный плагин, затем начните новую сессию. Запустите первый навык, например /egm:egm-brainstorm, для функции, которой нужны проектные решения.
Какие агенты для программирования поддерживаются?Работает с Antigravity, Claude Code и Codex. Claude Cowork и ChatGPT Work тоже поддерживаются, но для них нужно отдельное руководство по настройке.
Что будет, если мой агент не может создать новых субагентов для ревью?Для ревью «золотыми рыбками» нужны новые субагенты-сессии без контекста. Если агент не может их создать, EGM просто останавливает ревью. Даже успешное ревью не заменяет тесты и ваше собственное суждение.
Чем отличаются роли «Слон» и «Золотая рыбка»?«Слон» хранит контекст вашего проекта и требования, чтобы составить спецификацию. Рецензенты-«золотые рыбки» видят только документ и упомянутый исходный код, без предыдущего разговора, поэтому они могут заметить непроговорённые допущения и слепые зоны.
Когда стоит обойтись без EGM и просто писать код?Для небольшого и понятного исправления ошибки в README советуют использовать обычный рабочий процесс разработки. EGM предназначен для функций, которым сначала нужны настоящие проектные решения.
Какие навыки входят в плагин?Мозговой штурм (краткое описание концепции), Черновик (проектный документ), Разбор (работа с замечаниями ревью), Инициализация (документация кодовой базы), Ревью (пятиэтапное ревью свежими агентами), Цикл ревью (запуск определённой группы рецензентов) и Отчёт о расхождениях (сравнение документации с текущим кодом).
Куда попадают утверждённые проектные спецификации?Утверждённые спецификации нужно сохранять в docs/designs/ в вашем проекте, как описано в руководстве по рабочему процессу.
Какие есть похожие проекты?pstack-claude, conductor, operator-memory, orca, agents, BMAD-METHOD, everything-claude-code, superpowers-zh
Автор
google
Размер
14.9 MB
Звёзды
20.8K
Возраст
2 мес
Коммиты · 90 дней