dream-wf 0.1.0 → 0.1.2

package/README.md

@@ -1,80 +1,130 @@
 # DREAM-WORKFLOW
 
-Personal Trellis workflow patch installer for Cursor, Claude Code, and OpenCode.
+面向 Codex、Claude Code、OpenCode 和 Cursor 的 Workflow patch 安装聚合器。
 
-`dream-wf` does not replace Trellis. It installs a small custom profile on top of Trellis:
+`dream-wf` 不替代 Trellis。它是在 Trellis 之上安装一组项目级个人 workflow 约束，同时聚合配置 MCP servers 和 skills：
 
-- PRD clarification uses grill-me behavior automatically; the user does not need to mention `dream-wf`.
-- Trellis task lifecycle, specs, hooks, skills, sub-agents, checks, and finish-work remain native.
-- Initial spec candidates combine user answers, PRD decisions, and verified project facts.
-- Code semantic search prefers `fast-context-mcp`.
-- External docs and live web search prefer `grok-search-mcp`.
-- Strict mode guards against implementation before active task / PRD confirmation.
+- 平台选择：Cursor / Claude Code / OpenCode / Codex
+- Skill 安装：`dream-wf-grill-prd`（Trellis patch · grill-me 风格 PRD）、`dream-wf-mcp-policy`（MCP 优先级策略）
+- MCP 配置：`fast-context-mcp`（代码语义检索）、`grok-search-mcp`（外部文档/实时网络检索）
+- 交互式 TUI：上下选择、space 选中、enter 下一步/安装
+- PRD 澄清自动采用 grill-me 风格，用户不需要显式提到 `dream-wf`
+- Trellis 原生的任务生命周期、spec、hooks、skills、sub-agents、checks 和 finish-work 保持不变
+- strict 模式会阻止无活跃任务或 PRD 未确认时的实现类操作
 
-## Install
+## 安装
+
+### 交互式 TUI（推荐）
+
+```bash
+npx dream-wf
+```
+
+无参数时自动进入 TUI：
+
+1. 第一步选择平台（claude code / codex / opencode / cursor）
+2. 第二步选择要安装的 skills（默认全选）
+3. 第三步选择要配置的 MCP servers（默认全选）
+4. enter 确认安装
+
+操作键：
+
+- `↑/↓` 移动光标
+- `space` 切换选中
+- `a` 全选/全不选
+- `enter` 下一步/确认
+- `ctrl+c` 退出
+
+### 命令行模式
 
 ```bash
 npx dream-wf init -p cursor
 npx dream-wf init -p claude
 npx dream-wf init -p opencode
+npx dream-wf init -p codex
 ```
 
-`-p` is required. Default install is project-level and default mode is `strict`.
+`-p` 是必填参数。默认安装范围是项目级，默认模式是 `strict`，默认安装全部 skills 和 MCPs。
 
-## Commands
+## 命令
 
 ```bash
-npx dream-wf init -p cursor
-npx dream-wf doctor -p cursor
-npx dream-wf update -p cursor
+npx dream-wf                                  # 交互式 TUI
+npx dream-wf interactive                      # 同上
+npx dream-wf init -p <platform> [options]
+npx dream-wf doctor -p <platform>
+npx dream-wf update -p <platform>
 ```
 
-Options:
+参数：
 
 ```bash
--p cursor|claude|opencode
---mode strict|advisory
---install-deps
---developer <name>
+-p cursor|claude|opencode|codex              # 必填
+--mode strict|advisory                        # 默认 strict
+--skills <id,id,...>                          # 指定 skill id，默认全部
+--mcps <id,id,...>                            # 指定 mcp id，默认全部
+--skip-skills                                 # 不安装任何 skill
+--skip-mcps                                   # 不配置任何 mcp
+--install-deps --developer <name>            # 自动初始化 Trellis
 ```
 
-## Trellis Dependency
+Skill ids：
 
-Source: https://github.com/mindfold-ai/trellis
+- `trellis-dream-wf-patch`（dream-wf-grill-prd）
+- `dream-wf-mcp-policy`
+
+MCP ids：
+
+- `fast-context`（fast-context-mcp）
+- `grok-search`（grok-search-mcp）
+
+## 平台支持
+
+| 平台 | 入口规则 | Skills 目录 | Hook 类型 | MCP 配置文件 |
+|------|---------|------------|----------|-------------|
+| Cursor | `.cursor/rules/dream-wf.mdc` | `.cursor/skills/` | `preToolUse` (python) | `.cursor/mcp.json` |
+| Claude Code | `CLAUDE.md` | `.claude/skills/` | `PreToolUse` (python) | `.mcp.json` |
+| OpenCode | `AGENTS.md` | `.opencode/skills/` | `tool.execute.before` plugin (js) | `opencode.json` |
+| Codex | `AGENTS.md` | `.codex/skills/` | `PreToolUse` (python, hooks.json) | `.codex/config.toml` |
+
+## Trellis 
+
+来源：https://github.com/mindfold-ai/trellis
 
 ```bash
 npm install -g @mindfoldhq/trellis@latest
 ```
 
-Initialize Trellis first, or let `dream-wf` tell you the exact command:
+先初始化 Trellis，或者让 `dream-wf` 输出对应的初始化命令：
 
 ```bash
-trellis init -u your-name --cursor
-trellis init -u your-name --claude
-trellis init -u your-name --opencode
+trellis init -u your-name --cursor --yes
+trellis init -u your-name --claude --yes
+trellis init -u your-name --opencode --yes
+trellis init -u your-name --codex --yes
 ```
 
-## Grill Me Dependency
+## Grill Me 
 
-Source: https://github.com/mattpocock/skills/blob/main/skills/productivity/grill-me/SKILL.md
+来源：https://github.com/mattpocock/skills/blob/main/skills/productivity/grill-me/SKILL.md
 
-`dream-wf` installs a project-local `dream-wf-grill-prd` skill that vendors the behavior:
+`dream-wf` 会安装项目级 `dream-wf-grill-prd` skill，用于复用 grill-me 的交互风格：
 
-- Ask one question at a time.
-- Provide options and a recommended answer.
-- Inspect code before asking when possible.
-- Update `prd.md` after each answer.
-- Require explicit PRD confirmation before implementation.
+- 一次只问一个问题。
+- 给出选项和推荐答案。
+- 尽可能先检查代码再提问。
+- 用户回答后更新 `prd.md`。
+- 实现开始前必须获得明确的 PRD 确认。
 
 ## Fast Context MCP
 
-Source: https://github.com/SammySnake-d/fast-context-mcp
+来源：https://github.com/SammySnake-d/fast-context-mcp
 
 ```bash
 npm install @sammysnake/fast-context-mcp
 ```
 
-Example MCP server config:
+MCP server 配置示例：
 
 ```json
 {
@@ -94,9 +144,9 @@ Example MCP server config:
 
 ## Grok Search MCP
 
-Source: https://github.com/GuDaStudio/GrokSearch
+来源：https://github.com/GuDaStudio/GrokSearch
 
-Requires Python 3.10+ and `uv` / `uvx`.
+需要 Python 3.10+ 和 `uv` / `uvx`。
 
 ```json
 {
@@ -119,47 +169,57 @@ Requires Python 3.10+ and `uv` / `uvx`.
 }
 ```
 
-Do not commit real API keys or MCP secrets into project files.
+## 生成文件
 
-## Generated Files
-
-Cursor:
+Cursor：
 
 - `.cursor/rules/dream-wf.mdc`
 - `.cursor/skills/dream-wf-grill-prd/SKILL.md`
 - `.cursor/skills/dream-wf-mcp-policy/SKILL.md`
 - `.cursor/hooks/dream-wf-guard.py`
 - `.cursor/hooks.json`
+- `.cursor/mcp.json`
 
-Claude Code:
+Claude Code：
 
 - `CLAUDE.md` dream-wf entry block
 - `.claude/skills/dream-wf-grill-prd/SKILL.md`
 - `.claude/skills/dream-wf-mcp-policy/SKILL.md`
 - `.claude/hooks/dream-wf-guard.py`
 - `.claude/settings.json`
+- `.mcp.json`
 
-OpenCode:
+OpenCode：
 
 - `AGENTS.md` dream-wf entry block
 - `.opencode/skills/dream-wf-grill-prd/SKILL.md`
 - `.opencode/skills/dream-wf-mcp-policy/SKILL.md`
 - `.opencode/plugins/dream-wf-guard.js`
+- `opencode.json`
+
+Codex：
 
-Trellis:
+- `AGENTS.md` dream-wf entry block
+- `.codex/skills/dream-wf-grill-prd/SKILL.md`
+- `.codex/skills/dream-wf-mcp-policy/SKILL.md`
+- `.codex/hooks/dream-wf-guard.py`
+- `.codex/hooks.json`
+- `.codex/config.toml`（含 `[features] hooks = true` 和 `[mcp_servers.*]`）
 
-- Appends a `Dream WF Profile` section to `.trellis/workflow.md`.
-- Installs `.trellis/spec/guides/dream-wf-prd-policy.md`.
-- Installs `.trellis/spec/guides/dream-wf-mcp-policy.md`.
+Trellis：
 
-## Strict Mode
+- 向 `.trellis/workflow.md` 追加 `Dream WF Profile` 区块。
+- 安装 `.trellis/spec/guides/dream-wf-prd-policy.md`。
+- 安装 `.trellis/spec/guides/dream-wf-mcp-policy.md`。
 
-Strict mode blocks mutating actions when:
+## Strict 模式
 
-- No active Trellis task exists.
-- A task is still in `planning` and `prd.md` is not confirmed.
+strict 模式会阻止以下变更类操作：
 
-Mark PRD confirmation with one of these markers in `prd.md`:
+- 当前没有活跃 Trellis task。
+- task 仍处于 `planning` 状态，且 `prd.md` 尚未确认。
+
+可以在 `prd.md` 中使用以下任一标记表示 PRD 已确认：
 
 ```markdown
 PRD confirmed
@@ -167,12 +227,19 @@ confirmed: true
 status: confirmed
 ```
 
-## Security
+## 安全检查
 
-Run doctor before committing:
+提交前运行 doctor：
 
 ```bash
 npx dream-wf doctor -p cursor
+npx dream-wf doctor -p codex
 ```
 
-The doctor checks for obvious MCP secret patterns in project files and reports suspicious findings.
+doctor 会检查：
+
+- 必需二进制（node、python3、trellis、uvx）
+- Trellis 项目目录和 workflow.md
+- 平台对应的规则、skills、hook 文件
+- MCP 配置文件存在性和默认 MCP 条目完整性
+- 项目文件中的密钥泄露扫描

package/core/grill-prd-policy.md

@@ -12,6 +12,7 @@ Use grill-me behavior during Trellis planning. This replaces only the interview
 - If a question can be answered by exploring the codebase, docs, config, existing specs, or task history, explore first instead of asking the user.
 - After each answer, update `prd.md` immediately.
 - Keep open questions explicit until they are answered or intentionally deferred.
+- **Before requesting PRD confirmation, perform a Knowledge Verification pass.** Use `grok-search-mcp` (`web_search`, `web_fetch`) to verify technical assumptions that could be outdated or wrong. Record results in the `## Knowledge Verification` section of `prd.md`. Correct any outdated assumptions. Move unverified points to `Open Questions`. Add `knowledge verified` to the PRD after verification is complete.
 - Do not start implementation until the PRD is reviewed and confirmed.
 
 ## Required PRD Sections
@@ -23,6 +24,7 @@ Use grill-me behavior during Trellis planning. This replaces only the interview
 - Acceptance criteria
 - Decisions
 - Technical notes
+- Knowledge verification
 - Open questions
 - Spec candidates
 

package/core/workflow-profile.md

@@ -24,6 +24,7 @@ Keep the native Trellis flow:
 ## Dream WF Patch Points
 
 - Use `dream-wf-grill-prd` for PRD clarification instead of open-ended brainstorm interviewing.
+- **Before PRD confirmation, perform a Knowledge Verification pass**: use `grok-search-mcp` (`web_search`, `web_fetch`) to verify technical assumptions that could be outdated or wrong. Record results in the `## Knowledge Verification` section of `prd.md`. Correct outdated assumptions. Add `knowledge verified` to the PRD after verification is complete.
 - Generate initial spec candidates from user answers, PRD decisions, and verified project facts.
 - Prefer `fast-context-mcp` for codebase semantic search.
 - Prefer `grok-search-mcp` for external docs, live technical information, and webpage fetching.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "dream-wf",
-  "version": "0.1.0",
-  "description": "Personal Trellis workflow patch installer for Cursor, Claude Code, and OpenCode.",
+  "version": "0.1.2",
+  "description": "Trellis workflow patch installer and MCP/skill aggregator for Cursor, Claude Code, OpenCode and Codex.",
   "type": "module",
   "bin": {
     "dream-wf": "bin/dream-wf.js"
   },
   "scripts": {
-    "check": "node --check bin/dream-wf.js && node --check src/cli/index.js && node --check src/lib/files.js && node --check src/lib/platforms.js && node --check src/lib/trellis.js && node --check src/lib/json.js && node --check src/doctor/index.js && node --check src/deps/index.js && node --check src/platforms/shared.js && node --check src/platforms/cursor/index.js && node --check src/platforms/claude-code/index.js && node --check src/platforms/opencode/index.js && node --check templates/hooks/opencode/dream-wf-guard.js"
+    "check": "node --check bin/dream-wf.js && node --check src/cli/index.js && node --check src/lib/files.js && node --check src/lib/platforms.js && node --check src/lib/trellis.js && node --check src/lib/json.js && node --check src/lib/catalog.js && node --check src/lib/mcp.js && node --check src/doctor/index.js && node --check src/deps/index.js && node --check src/platforms/shared.js && node --check src/platforms/cursor/index.js && node --check src/platforms/claude-code/index.js && node --check src/platforms/opencode/index.js && node --check src/platforms/codex/index.js && node --check src/tui/index.js && node --check templates/hooks/opencode/dream-wf-guard.js"
   },
   "keywords": [
     "trellis",
@@ -15,6 +15,7 @@
     "cursor",
     "claude",
     "opencode",
+    "codex",
     "mcp"
   ],
   "license": "MIT",