OriginAI — Product specs for Claude Code, Cursor, and Codex

从代码仓库生成规格

指引编码 Agent 解析现有代码仓库，将产品架构与页面规格逆向同步至 OriginAI。

当产品已具备现有代码时，可以由编码 Agent 深入理解代码实现，并在 OriginAI 中将其提炼并沉淀为标准产品规格——明确产品定位、目标受众、核心业务旅程以及所有关键界面。随后由你在可视化工作台中确认并正式发布。

你完全无需预先在 OriginAI Web 界面中创建项目。 借助 CLI，在本地代码仓库中即可通过 create-project 直接完成创建与绑定。

这一模式非常适合以下场景：代码已经成型，但团队尚未沉淀出一份供产研各方和 AI Agent 共同遵从的产品上下文基准。

开始之前

在开始前，请确认具备以下条件：

  • 一个已注册的 OriginAI 账户。
  • 本地环境可运行的 originai CLI（推荐直接执行 npx originai）。
  • 本地现有的产品代码仓库。
  • 你日常使用的编码 Agent（如 Claude Code、Cursor、Windsurf 或 Codex 等）。

操作流程

以下为标准执行流程；你可以根据当前准备情况从对应步骤切入。

1. 本地机器授权登录

在每台开发设备上仅需执行一次授权：

npx originai login

该命令将在浏览器中打开授权页面。登录成功后，凭据将安全保存在本机环境——切勿将凭据提交至 Git 仓库。

如果你使用的是私有化部署或自定义开发环境，请在登录前配置 CLI 服务端点：

npx originai config
npx originai config set api_url <API URL>
npx originai config set web_url <web URL>

2. 让编码 Agent 创建项目并提取规格

在代码仓库根目录下，将以下提示词（Prompt）直接提供给你的编码 Agent。Agent 将自动执行 create-project、写入本地配置文件 .origin.json，并一次性完成代码库的产品结构索引：

This git repository is existing product code. Create OriginAI product specs from it (repo → Origin). Do not invent UX the code does not clearly show.

Auth (human, once per machine): run `npx originai login` in this repo if you have not.

1. If `.origin.json` has no `project_id`, run `npx originai create-project --name "<product name from the repo>"` (it writes `.origin.json` when unbound). Then `npx originai link --project <id> --skill` if the skill files are missing. Commit `.origin.json` (no secrets).
2. If a project is already bound, skip create-project. Do not create a second project.
3. Browse the tree and main entry points. Summarize who the product serves, the problem, roles, and main flows.
4. Initialize fully in one pass. Write `README.rpml` first (`mode="doc"` product design doc). `validate --content` then `write-document`. No local `.rpml` files.
5. Immediately author one `.rpml` per page/route in that planning — do not stop after the README.
6. Read back with `list-documents --read-type workspace`. Confirm every planned page has a `.rpml`.
7. Tell the human: open OriginAI, review the specs, then publish a release.

在 OriginAI 项目创建页 的 已有代码仓库 标签中亦可获取该提示词。

若已在 OriginAI 中建有对应项目，只需先运行 npx originai link --project <id> 绑定，跳过新建项目步骤即可。

关联操作会在仓库根目录生成轻量元数据文件 .origin.json，其中仅包含项目 ID，不含任何敏感密钥。请将其提交至版本控制系统（Git），以确保团队成员共享相同的项目绑定。

3. 在 Web 工作台中审核规格

登录 OriginAI 打开对应项目，在概览页面和画布上查看自动生成的规格，针对与真实意图有偏差之处进行调整。这一步骤至关重要：高质量的产品规格应当读起来像专业的产品设计文档，而不是代码注释的机械拼接。

4. 发布首个 Release

当规格核验无误后，发布首个 Release 版本。自发布起，规格基准被正式冻结；后续编码 Agent 对规格的补充或变更将以变更请求（Change Request）形式提交，由你审核应用后再次发布新版。

项目完成关联后，研发流程即可顺畅反转：在平台工作台中维护与更新规格、发布新版本，再让编码 Agent 对齐最新规格编写代码。这正是将规格共享给团队或编码 Agent所阐述的核心闭环。

常见问题排查

现象排查建议
读取到的规格为空项目可能尚未发布 Release——请指定 --read-type workspace 读取工作区草稿，或先发布首个版本。
Agent 无法直接写入工作区检查是否已正确登录与绑定项目。若项目已发布过 Release，直接写入将自动转为暂存变更请求。
生成的规格过于偏向实现细节在提示词中强调从最终用户角度和业务场景出发；优先校准 README 概览，再对齐具体页面。
Agent 提示写入成功但网页未展示核对项目 ID 是否一致，刷新浏览器页面，或让 Agent 回读校验规格列表。

相关内容

在 OriginAI 上创建项目

从产品需求描述开始，自动生成结构化规格，在工作台中调优后发布首个版本。

将规格共享给团队或编码 Agent

将已发布的产品规格准确交付给团队成员与各类编码 Agent。

On this page

开始之前操作流程1. 本地机器授权登录2. 让编码 Agent 创建项目并提取规格3. 在 Web 工作台中审核规格4. 发布首个 Release常见问题排查相关内容