Skip to content

Latest commit

 

History

History
191 lines (137 loc) · 9.89 KB

File metadata and controls

191 lines (137 loc) · 9.89 KB

Trellis Logo

给 AI 立规矩的开源框架
支持 Claude Code、Cursor、OpenCode、iFlow、Codex、Kilo、Kiro、Gemini CLI、Antigravity 和 Qoder。

English文档快速开始支持平台使用场景微信群

npm version npm downloads license stars docs Discord open issues open PRs Ask DeepWiki Ask ChatGPT

Trellis 工作流演示

Trellis 工作流演示

为什么用 Trellis?

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

快速开始

# 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--qoder
  • 更完整的安装步骤、各平台入口命令和升级方式放在文档站: 快速开始支持平台使用场景

使用场景

把项目知识一次性交给 AI

把编码规范、目录规则、评审习惯和工作流偏好写进 Markdown Spec。Trellis 会自动加载相关部分,你不需要每次都从头解释这个项目怎么做事。

并行推进多个 AI 任务

借助 git worktree 和 Trellis 的任务结构,可以把不同任务拆开并行推进。多个 Agent 同时工作时,分支和本地状态也不会互相踩来踩去。

把项目历史变成可用记忆

任务 PRD、检查清单和 workspace journal 会把上一次的决策留下来。下一次进场的 Agent 不需要从零开始猜上下文。

在不同工具之间保持同一套流程

如果团队不会只用一个 AI coding 工具,Trellis 可以把 Spec、Task 和流程结构统一起来。平台接入方式会变,但工作流本身不需要重学。

工作原理

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

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

根据你启用的平台不同,Trellis 还会生成对应的接入文件,比如 .claude/.cursor/AGENTS.md.agents/.kilocode/.kiro/

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

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

Spec 模板与 Marketplace

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

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

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

最新进展

  • 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.1trellis update 后台 watch 模式、.gitignore 处理改善、文档更新。
  • v0.3.0:支持平台从 2 个扩展到 10 个、Windows 兼容、远程 Spec 模板、/trellis:brainstorm

常见问题

它和 CLAUDE.mdAGENTS.md.cursorrules 有什么区别?

这些文件当然有用,但它们很容易越写越大、越写越散。Trellis 在它们之外补上了结构:分层 Spec、任务上下文、workspace 记忆,以及按平台接入的工作流。

Trellis 只适合 Claude Code 吗?

不是。Trellis 目前支持 Claude Code、Cursor、OpenCode、iFlow、Codex、Kilo、Kiro、Gemini CLI 和 Antigravity。每个平台的具体接入方式和入口命令,文档站都有单独说明。

是不是每个 Spec 都得手写?

不需要。很多团队一开始会先让 AI 根据现有代码起草 Spec,再把真正关键的规则和经验手动收紧。Trellis 的价值不在于把所有文档都写满,而在于把高信号规则沉淀下来并持续复用。

团队一起用会不会经常冲突?

不会。个人 workspace journal 是按开发者隔离的;共享的 Spec 和 Task 则作为仓库内容正常走评审和迭代,和其他工程资产一样管理。

Star History

Star History Chart

社区与资源

微信群

Trellis AI 框架中文社群二维码

官方仓库AGPL-3.0 License • Built by Mindfold