Skip to content

Apparux/trellis-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Trellis Kit

Trellis Kit 不替代 Trellis 原生工作流,只补充几个聚焦的 Claude 命令:

  • /task <task-id>:切换/启动/继续 Trellis task,并在 implementation 前决定开发位置。
  • /fix <request>:小 bug、小改动的快车道。
  • /review:为当前 Trellis task 生成 review brief,并通过 trellis channel 调用 Codex check worker;也支持 rereview mode。
  • /review-fix:读取最近一次 Codex review 结果,只修复 Blocking / Should Fix findings。
  • /spec-cleanup:自动整理、归档、废弃并合并 .trellis/spec/

它是一个无运行时依赖的小型 Node.js CLI 包。这个工具只在本地工作。安装过程不会创建 GitHub Actions,不会 push,不会 merge,也不会运行 Codex Review。

English README

重命名说明

本项目原名为 trellis-codex-review-kit,现已更名为 trellis-kit

新的 npm 包名和 CLI 命令均为:

trellis-kit

如果你之前全局安装过旧包,请先卸载旧包:

npm uninstall -g trellis-codex-review-kit
npm install -g trellis-kit

如果你的项目脚本中仍引用旧命令,请将:

trellis-codex-review-kit

替换为:

trellis-kit

安装内容

运行 trellis-kit init 会安装 Markdown 模板和 Claude 命令模板:

.trellis/spec/guides/review-workflow.md
.trellis/spec/guides/review-loop-workflow.md
.trellis/spec/templates/review-brief-template.md
.trellis/spec/templates/rereview-brief-template.md
.trellis/spec/templates/review-fix-summary-template.md
.trellis/spec/guides/development-location-decision.md
.trellis/spec/guides/fast-path-change-policy.md
.trellis/spec/guides/spec-cleanup-guide.md
.claude/commands/task.md
.claude/commands/fix.md
.claude/commands/review.md
.claude/commands/review-fix.md
.claude/commands/spec-cleanup.md

这些安装后的文件应该提交到目标项目中,这样工作流就能保持稳定、可审查,并且团队可以按需编辑。

前置条件

  • Node.js
  • git
  • Trellis
  • Claude Code
  • 可通过 codex 命令访问的 Codex CLI(可选;仅在运行 /review/review --rereview 的 Codex worker 时需要)

安装包

在本包仓库中运行(本地开发安装):

npm install -g .

从 npm 安装(远程安装):

npm install -g trellis-kit

如果你不想全局安装,也可以通过 npx 直接运行已发布的 CLI:

npx trellis-kit init

验证:

trellis-kit --help
trellis-kit --version

本地开发

在本仓库中直接运行 CLI:

node bin/trellis-kit.js --help
node bin/trellis-kit.js init --dry-run

安装到项目

示例初始化流程:

cd your-project
trellis init -u amin --claude --codex
trellis-kit init

只预览、不写文件:

trellis-kit init --dry-run

如果你确实想在 init 时重新安装并覆盖已有文件:

trellis-kit init --force

预览覆盖操作但不写文件:

trellis-kit init --force --dry-run

如果是日常更新已经安装过的 kit 文件,请使用 update,不要再用 init --force;见更新已安装文件

默认情况下,init 会跳过已有文件:

SKIP existing: .claude/commands/task.md

日常工作流

/task <task-id> — 完整 Trellis Task 入口

使用 /task <task-id> 处理已准备好的 Trellis task。它会解析当前或指定 task,只在唯一匹配后切换 task,读取开发位置选择 guide,在需要 implementation 前询问使用当前工作区还是 .worktrees/<task-id>,然后继续 Trellis 原生 /trellis:continue 阶段路由。

/task 06-24-school-operation-log
/task school-operation-log

/task 不创建新 task,不默认读取整个 .trellis/spec/,不自动生成 Review Brief,也不会自动 review、commit、push、merge、rebase 或 finish-work。

/fix <request> — 快速修复

/fix 用于在当前工作区完成小 bug、小改动和低风险 patch。它默认不创建完整 Trellis task,不创建 PRD/DESIGN/TASK,不生成 Review Brief,不 commit,也不执行 review。

/fix 修复学生档案导出时手机号为空导致 NPE 的问题
/fix 学生档案列表里班级名称字段现在返回 classId,改成返回 className

/review — Trellis Channel Review

使用 /review 为当前 active Trellis task 生成 review-brief.md,并通过 trellis channel 创建 review channel、spawn Codex check worker、发送 brief、等待 done、保存 review 结果。

/review

默认输出路径:

.trellis/tasks/<task>/review/review-brief.md
.trellis/tasks/<task>/review/codex-review.md

如果已有历史文件,会使用 review-brief-001.mdcodex-review-001.md 等编号文件。/review 是 channel wrapper,不自己实现 worker 调度、等待、消息读取或清理逻辑。

/review-fix — Review 问题修复

使用 /review-fix 读取当前 task 最近一次 Codex review 结果,分类 findings,并默认只修复 Blocking / Should Fix。

/review-fix

/review-fix 会写出:

.trellis/tasks/<task>/review/review-fix-summary.md

它不调用 reviewer,不 spawn worker,不 wait channel,不运行 /review --rereview,也不 commit。Nice to Have 默认不修,False Positive 只记录原因,Needs Human Decision 写入待确认说明。

/review --rereview — Trellis Channel Re-review

使用 /review --rereview/review-fix 修复后,通过同一套 trellis channel 流程让 Codex 复审。

/review --rereview

复审会读取上次 review 结果、review fix summary 和当前修复 diff,生成 rereview-brief.md,并保存下一份 codex-review*.md。复审重点是:上次 findings 是否已修复、修复是否引入新问题、是否仍有 Blocking 问题。

/spec-cleanup — Spec 清理

/spec-cleanup 会自动审查、安全整理并整合 .trellis/spec/。它会保留当前有效规则,自动归档历史任务文档,自动废弃已被替代的旧流程规则,把低风险重复 spec 自动合并到 canonical guide,更新旧引用到 canonical 文件,并移除过时的全量读取 spec 写法,但不覆盖 Trellis 原生 context 选择。只有在删除、歧义、冲突或会改变核心行为的操作时才会询问确认。

/spec-cleanup

选择性 Spec 加载

命令不应默认盲目全量读取 .trellis/spec//task/fix 交给 Trellis 原生 workflow、task context 和 spec index 判断哪些项目规则相关;/review/review-fix/review --rereview/spec-cleanup 会先读取自己的目标 guide/template,再按命令需要检查相关文件。

开发位置选择

worktree 选择发生在 /task 中,并且必须在 implementation 前完成。

如果用户选择任务专用 worktree,固定使用:

.worktrees/<task-id>

分支名固定为:

task/<task-id>

创建 task worktree 前,Agent 会确认 .gitignore 是否包含 .worktrees/;如果缺失,会先询问是否添加。如果 Trellis planning/design/task artifacts 尚未提交,它会先提醒。若 implementation 已经开始且代码有未提交改动,默认继续使用当前工作区。

不得在以下位置创建 worktree:

.trellis/worktrees/
../<repo>-worktrees/
../<repo>-<task-id>
/tmp/

Review Brief 与 Review 闭环

Review Brief Markdown 是 /review 发送给 Codex check worker 的结构化输入,不是 Trellis check 的替代品。

推荐 review 闭环:

  1. Claude Code / Trellis 完成实现和本地检查。
  2. 使用 /review 生成 review-brief.md,并通过 trellis channel 运行 Codex check worker。
  3. /review 保存 Codex 输出到 .trellis/tasks/<task>/review/codex-review.md 或编号文件。
  4. 使用 /review-fix 修复 Blocking / Should Fix findings,并生成 review-fix-summary.md
  5. 使用 /review --rereview 基于上次 review、fix summary 和本次 diff 复审。

/review/review --rereview 只通过 trellis channel 执行 worker 调度、发送、等待和消息读取,不维护独立 runtime。/review-fix 不调用 reviewer,不 spawn worker,不 wait channel。Nice to Have 默认不修;False Positive 和 Needs Human Decision 会写入 summary。

Trellis Channel Review

本 kit 不安装 bundled review 脚本。Review worker 执行层由 trellis channel 接管。

排查 channel 时优先使用:

trellis channel messages <channel-name> --raw --last 100
trellis channel messages <channel-name> --raw --kind progress --last 100
trellis channel ls

不要把直接读取 events.jsonl 作为主要结果读取方式,除非是最后排障手段。

安全规则

安装器不会:

  • 修改 .trellis/workflow.md
  • 运行 trellis init
  • 安装 Trellis、Claude Code 或 Codex CLI。
  • 在安装过程中运行 Codex Review。
  • 默认删除文件;只有 update --prune-old 会删除 .trellis/scripts/.trellis/spec/scripts/ 下文档列出的遗留 review 脚本,以及 .trellis/spec/ 下已改名的旧模板。
  • 删除目标项目中旧版本留下的 Claude 命令文件。
  • 在未传入 --forceinit 或未明确运行 update 时覆盖文件。
  • push、merge 或 rebase。
  • 修改远端仓库。
  • 创建 .worktrees/ 目录。
  • 修改目标项目 .gitignore

安装后的工作流会要求 Claude Code 遵守:

  • Claude Code 负责实现已准备好的 task、小修复和 review findings 明确指出的问题。
  • Trellis 内置 check 是默认验证方式。
  • /review/review --rereview 通过 trellis channel 调用 Codex check worker。
  • /review-fix 只负责根据 saved review findings 修复代码,不负责 worker 调度。
  • Nice to Have 默认不自动修。
  • 是否 commit、push、merge 或 finish-work 由用户决定。

更新已安装文件

当项目里已经安装过这个 kit,想把已安装模板更新到当前包版本时,请运行:

trellis-kit update

update 会用包内模板覆盖已安装的 kit 文件。运行前请先检查本地自定义内容。

如果你正在从旧版本迁移,旧版本曾把 review 脚本安装到 .trellis/scripts/.trellis/spec/scripts/,或在 .trellis/spec/ 下安装过已改名的旧 Review Brief 模板,可以在安装当前文件后显式清理这些旧文件:

trellis-kit update --prune-old

--prune-old 只会删除下面这些存在的遗留文件:

.trellis/scripts/codex-review.sh
.trellis/scripts/codex-rereview.sh
.trellis/scripts/codex-review.ps1
.trellis/scripts/codex-rereview.ps1
.trellis/spec/scripts/codex-review.sh
.trellis/spec/scripts/codex-rereview.sh
.trellis/spec/scripts/codex-review.ps1
.trellis/spec/scripts/codex-rereview.ps1
.trellis/spec/guides/claude-codex-review-workflow.md
.trellis/spec/guides/review-handoff-workflow.md
.trellis/spec/templates/codex-handoff-template.md
.trellis/spec/templates/review-handoff-template.md
.trellis/spec/templates/rereview-handoff-template.md
.claude/commands/handoff.md
.claude/commands/rereview.md

不确定时先 dry run:

trellis-kit update --dry-run
trellis-kit update --dry-run --prune-old

迁移说明

Claude 命令面

旧版本可能安装过 .claude/commands/dev.md。如果存在,请确认不再需要后手动删除。

Worktree 路径变更

旧版本可能推荐过 ../<repo>-worktrees/<task-id>../<repo>-<task-id>.trellis/worktrees/<task-id> 等 worktree 路径。当前版本统一使用 .worktrees/<task-id>

故障排查

.trellis directory not found

先在目标项目中初始化 Trellis:

trellis init -u amin --claude --codex

安装器会警告缺少 .trellis,但不会失败,因为有些用户可能会手动准备目录。

本地手动测试概要

npm install -g .
trellis-kit --help
trellis-kit --version

rm -rf /tmp/trellis-kit-test
mkdir /tmp/trellis-kit-test
cd /tmp/trellis-kit-test
git init
mkdir -p .trellis .claude
trellis-kit init

test -f .trellis/spec/guides/review-workflow.md
test -f .trellis/spec/guides/review-loop-workflow.md
test -f .trellis/spec/templates/review-brief-template.md
test -f .trellis/spec/templates/rereview-brief-template.md
test -f .trellis/spec/templates/review-fix-summary-template.md
test -f .trellis/spec/guides/development-location-decision.md
test -f .trellis/spec/guides/fast-path-change-policy.md
test -f .trellis/spec/guides/spec-cleanup-guide.md
test -f .claude/commands/task.md
test -f .claude/commands/fix.md
test -f .claude/commands/review.md
test -f .claude/commands/review-fix.md
test -f .claude/commands/spec-cleanup.md
test ! -f .claude/commands/dev.md

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors