trellis封面图

Trellis – 给 AI 立规矩的开源框架

Trellis Logo

给 AI 立规矩的开源框架。

支持 Claude Code、Cursor、OpenCode、iFlow、Codex、Kilo、Kiro、Gemini CLI、Antigravity、Windsurf、Qoder、CodeBuddy、GitHub Copilot 和 Factory Droid。

核心能力

能力	带来的变化
自动注入 Spec	把规范写进 `.trellis/spec/` 之后，Trellis 会在每次会话里注入当前任务真正需要的上下文，不用反复解释。
任务驱动工作流	PRD、实现上下文、检查上下文和任务状态都放进 `.trellis/tasks/`，AI 开发不会越做越乱。
并行 Agent 执行	用 git worktree 同时推进多个 AI 任务，不需要把一个分支挤成大杂烩。
项目记忆	`.trellis/workspace/` 里的 journal 会保留上一次工作的脉络，让新会话不是从空白开始。
团队共享标准	Spec 跟着仓库一起版本化，一个人总结出来的规则和流程，可以直接变成整个团队的基础设施。
多平台复用	同一套 Trellis 结构可以带到 14 个 AI coding 平台上，而不是每换一个工具就重搭一次工作流。

环境要求

Node.js ≥ 18
Python ≥ 3.10（hooks 和自动化脚本需要）

快速开始

1. 安装 Trellis

npm install -g @mindfoldhq/trellis@latest

2. 在仓库里初始化

trellis init -u your-name

3. 或者按你实际使用的平台初始化

trellis init --cursor --opencode --codex -u your-name

说明：

-u your-name 会创建 .trellis/workspace/your-name/，用来保存个人 journal 和会话连续性。
平台参数可以自由组合。当前可选项包括 --cursor、--opencode、--iflow、--codex、--kilo、--kiro、--gemini、--antigravity、--windsurf、--qoder、--codebuddy、--copilot 和 --droid。

核心命令

命令	用途
`/start`	加载项目上下文。每次开始工作时运行一次，支持 Hook 的平台会自动注入（Claude Code、iFlow、OpenCode、Codex 和 GitHub Copilot）。
`/brainstorm`	梳理需求并输出 PRD。启动新功能或需求不明确时使用。
`/before-dev`	编码前加载相关规范（自动检测前/后端）。在 `/brainstorm` 之后、写代码之前运行。
`/check`	按规范检查代码并自动修复违规（自动检测前/后端）。写完代码后、提交前运行。
`/finish-work`	提交前 checklist，覆盖 lint、测试、文档和 API 变更。在 git commit 前作为最终关卡运行。
`/parallel`	在隔离的 git worktree 中启动多个 Agent。适用于可拆分为独立子任务的大型任务。
`/record-session`	将会话摘要写入 workspace journal。在人工测试并 commit 代码之后运行。
`/update-spec`	将新模式或规范沉淀到 spec 文件。发现值得保留的规则时随时运行。

使用示例

1. 自动注入 Spec

在 .trellis/spec/backend/database-guidelines.md 里写一次数据库命名规则，之后不管是你、队友、还是并行 Agent 发起的会话，都会自动注入这条规则。不用再每次往聊天窗口里贴同样的指令。

2. 并行 Agent 执行

用 /parallel 启动三个 Agent，各自在独立的 git worktree 和分支上工作。它们各自实现、自检、开 draft PR。你随时 review 合并，不用排队，不会冲突。

3. 项目记忆

下班前跑一次 /record-session，将当前会话摘要写入 workspace journal。第二天开新会话后通过 Hook 自动读取，AI 已经知道你昨天上了什么、哪里挂了、还剩什么没做。

4. 多平台复用

跑一次 trellis init --cursor --claude，两个工具读同一份 .trellis/spec/ 和 .trellis/tasks/。在 Claude Code 里改进的 spec，下次有人用 Cursor 打开项目时直接生效。

项目结构

Trellis 把核心工作流放在 .trellis/ 里，再按你启用的平台生成对应的接入文件。

.trellis/
├── spec/          # 项目规范、模式和指南
├── tasks/         # 任务 PRD、上下文文件和状态
├── workspace/     # Journal 和开发者级连续性
├── workflow.md    # 共享工作流规则
└── scripts/       # 驱动整个流程的脚本

根据你启用的平台不同，Trellis 还会生成对应的接入文件，比如 .claude/、.cursor/、AGENTS.md、.agents/、.codex/、.kilocode/、.kiro/skills/、.gemini/、.agent/workflows/（Antigravity）、.windsurf/workflows/、.qoder/、.codebuddy/、.github/copilot/、.github/hooks/、.github/prompts/ 和 .factory/（Droid）。

Codex 同时会安装 .agents/skills/ 下的项目技能（Cursor、Gemini CLI、GitHub Copilot、Amp、Kimi Code 共享此目录）。

整体流程

整体流程可以理解成四步：

把标准写进 Spec。
从任务 PRD 开始组织工作。
让 Trellis 为当前任务注入正确的上下文。
用检查、journal 和 worktree 保证质量与连续性。

Spec 模板

Spec 默认是空模板——需要根据你的项目技术栈和团队规范来填写。你可以从零开始写，也可以从社区模板起步：

# 从自定义仓库拉取模板
trellis init --registry https://github.com/your-org/your-spec-templates

浏览可用模板和了解如何发布你自己的模板，请查看 Spec 模板页面。

版本更新

v0.4.0：命令整合（before-backend-dev + before-frontend-dev → before-dev，check-backend + check-frontend → check），新增 /update-spec 命令用于将知识沉淀到 Spec，Python scripts 内部重构。
v0.3.6：任务生命周期 hooks、自定义模板仓库（–registry）、父子 subtask、修复 CC v2.1.63+ PreToolUse hook 失效。
v0.3.5：修复 Kilo workflows 删除迁移清单字段名。
v0.3.4：Qoder 平台支持、Kilo workflows 迁移、record-session 任务感知。
v0.3.1：trellis update 后台 watch 模式、.gitignore 处理改善、文档更新。
v0.3.0：支持平台从 2 个扩展到 10 个、Windows 兼容、远程 Spec 模板、/trellis:brainstorm。