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 是一个开源插件,内含一组技能,可以帮你借助上下文充足的 AI 代理起草软件规格说明,然后在写代码之前,用零上下文的评审子代理对其进行严格检验。
这是独立应用,还是要接入我的编码代理?它是一个插件,需要安装到已有的编码代理(Antigravity、Claude Code 或 Codex)中。它会为代理添加可供调用的技能,本身不能单独运行。
我该如何安装并开始使用?选择你的编码代理(Antigravity、Claude Code 或 Codex),安装完整的插件,然后开始新会话;再针对一个需要做设计决策的功能运行第一个技能,例如 /egm:egm-brainstorm。
它支持哪些编码代理?它支持 Antigravity、Claude Code 和 Codex;Claude Cowork 和 ChatGPT Work 也受支持,但需要单独的设置指南。
如果我的代理无法启动全新的子代理来做评审,会怎样?Goldfish 评审需要全新的、零上下文的子代理会话;如果你的代理无法创建这些会话,EGM 会直接停止评审。而且即使评审通过,也不能替代测试或你自己的判断。
Elephant 和 Goldfish 两种角色有什么区别?Elephant 保留你的项目上下文和需求,用来起草规格说明;Goldfish 评审员只看到文档和引用的源代码,看不到之前的对话,因此能发现未说明的假设和盲点。
什么时候应该跳过 EGM,直接写代码?对于小而明确的 bug 修复,README 建议改用你平常的编码流程;EGM 适用于那些需要先做真正设计决策的功能。
插件自带哪些技能?头脑风暴(概念简述)、起草(设计文档)、处理(应对评审发现的问题)、初始化(代码库文档)、评审(五阶段全新代理评审)、评审循环(运行指定的评审员组)和偏差报告(对比文档与当前代码)。
批准的设计规格最终保存在哪里?经批准的规格说明应保存在你项目中的 docs/designs/ 目录下,具体见工作流指南。
作者
google
大小
14.9 MB
星标
20.8K
时长
2个月
提交 · 90 天