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](https://chatgpt.com/plugins/plugins_6aeb90f47ec88191a3c107e01d3eb357) in the desktop app and install it. This listing is desktop-only. For Codex CLI, use the commands below. ### Antigravity CLI ```sh 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](docs/harnesses.md#antigravity-app-and-antigravity-for-ides). ### Claude Code ```sh claude plugin marketplace add google/elephant-goldfish-model claude plugin install egm@egm ``` ### Codex CLI ```sh 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](docs/harnesses.md). ## 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** ```text /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** ```text /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](https://github.com/google/elephant-goldfish-model/issues/220)), but 1.4.8 does not ([#196](https://github.com/google/elephant-goldfish-model/issues/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** ```text /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** ```text /egm-draft ``` The agent turns the brief into `design_draft.md`, pausing after each section for your feedback in chat. **Review the draft** ```text /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](docs/getting_started.md) 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](docs/harnesses.md#support-status--contributing-other-harnesses). ## 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.
 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 - [Getting started](docs/getting_started.md): the workflow and project layout. - [Setup](docs/harnesses.md): installation, agent capabilities, and known limits. - [Architecture](https://github.com/google/elephant-goldfish-model/blob/main/docs/designs/architecture.md): how skills and reviewers fit together. - [Testing](https://github.com/google/elephant-goldfish-model/blob/main/TESTING.md): checks, execution records, and verification limits. - [Dave Rensin’s original essay](https://medium.com/@drensin/elephants-goldfish-and-the-new-golden-age-of-software-engineering-c33641a48874): the ideas behind EGM. ## Contribute See the [accessibility statement](https://github.com/google/elephant-goldfish-model/blob/main/ACCESSIBILITY.md) for accessibility goals, known limits, and how to report barriers. Read [contributing](https://github.com/google/elephant-goldfish-model/blob/main/CONTRIBUTING.md) for PRs, [issues](https://github.com/google/elephant-goldfish-model/issues) for bugs, and [discussions](https://github.com/google/elephant-goldfish-model/discussions) for questions. ## License [Apache 2.0](LICENSE). This is not an officially supported Google product.