一款强大的跨平台 AI 编码框架
_{支持 Claude Code、Cursor、OpenCode、iFlow、Codex、Kilo、Kiro、Gemini CLI、Antigravity、Windsurf、Qoder、CodeBuddy 以及 GitHub Copilot。}

简体中文 • 文档 • 快速入门 • 支持的平台 • 应用场景

为什么选择 Trellis？

功能	带来的改变
自动注入规范	在 .trellis/spec/ 中只需编写一次约定，之后由 Trellis 自动将相关上下文注入到每次会话中，无需重复说明。
以任务为中心的工作流	将任务需求文档、实现上下文、评审上下文和任务状态保存在 .trellis/tasks/ 中，使 AI 工作保持结构化。
并行代理执行	使用 Git worktrees 并行运行多个 AI 任务，而不是把一个分支变成“交通拥堵”。
项目记忆	.trellis/workspace/ 中的日志会保留上次发生的情况，因此每次新会话都能基于真实背景开始。
团队共享标准	规范存储在代码库中，这样一个人辛苦建立的工作流程或规则可以惠及整个团队。
跨平台设置	可以将相同的 Trellis 结构应用到 13 种 AI 编码平台上，而无需为每种工具重新构建工作流程。

快速入门

# 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/，用于个人日志和会话连续性。
• 平台标志可以任意组合。当前选项包括 --cursor、--opencode、--iflow、--codex、--kilo、--kiro、--gemini、--antigravity、--windsurf、--qoder、--codebuddy 和 --copilot。
• 如需了解特定平台的设置、入口命令及升级路径，请参阅文档： 快速入门 • 支持的平台 • 实际应用场景

应用场景

向 AI 一次性传授你的项目知识

将编码标准、文件结构规则、评审习惯和工作流程偏好写入 Markdown 规范中。Trellis 会自动加载相关内容，这样你就无需每次都重新解释整个代码库。

并行运行多个 AI 任务

利用 Git worktrees 和 Trellis 的任务结构，可以将工作清晰地分配给不同的 AI 代理。不同任务可以同时推进，而不会互相干扰各自的分支或本地状态。

将项目历史转化为可用的记忆

任务的需求文档、检查清单和工作空间日志可以让之前的决策在下一次会话中继续发挥作用。下一个 AI 代理无需从零开始，而是可以直接接续上一次的工作。

在不同工具间保持一致的工作流程

如果你的团队使用多种 AI 编码工具，Trellis 可以提供一套统一的规范、任务和流程结构。虽然不同平台的具体配置会有所变化，但整体的工作流程仍然清晰可辨。

工作原理

Trellis 将核心工作流程保存在 .trellis/ 中，并围绕它生成所需的平台特定入口点。

.trellis/
├── spec/                    # 项目标准、模式和指南
├── tasks/                   # 任务需求文档、上下文文件和状态
├── workspace/               # 日志和开发者特定的连续性
├── workflow.md              # 共享的工作流程规则
└── scripts/                 # 支撑工作流程的实用工具

根据你启用的平台，Trellis 还会创建一些工具特定的集成文件，例如 .claude/、.cursor/、AGENTS.md、.agents/、.codex/、.kilocode/、.kiro/、.github/copilot/ 以及 .github/hooks/。对于 Codex，Trellis 现在会在 .agents/skills/ 下安装项目技能，同时在 .codex/ 下安装项目范围内的配置或自定义代理。

从高层次来看，工作流程很简单：

1. 在规范中定义标准。
2. 根据任务需求文档开始或细化工作。
3. 让 Trellis 注入当前任务所需的正确上下文。
4. 使用检查、日志和工作trees 来确保质量和连续性。

规范模板与市场

默认情况下，规范以空模板形式提供——它们需要根据你的项目技术栈和开发惯例进行定制。你可以从头开始填写，也可以直接使用社区提供的模板：

# 从自定义注册表获取模板
trellis init --registry https://github.com/your-org/your-spec-templates

浏览可用模板，并在Spec Templates 页面上了解如何发布您自己的模板。

新增功能

• v0.3.6: 任务生命周期钩子、自定义模板注册表（--registry）、父子子任务、修复 CC v2.1.63+ 的 PreToolUse 钩子。
• v0.3.5: 修复删除迁移清单字段名问题（Kilo 工作流）。
• v0.3.4: 支持 Qoder 平台、Kilo 工作流迁移、record-session 任务感知。
• v0.3.1: trellis update 的后台监听模式、改进的 .gitignore 处理、文档更新。
• v0.3.0: 平台支持从 2 个扩展到 10 个、Windows 兼容性、远程 Spec 模板、/trellis:brainstorm。

常见问题解答

这与 CLAUDE.md、AGENTS.md 或 .cursorrules 有何不同？

那些文件很有用，但往往变得过于庞大。Trellis 在它们的基础上增加了结构：分层的 Spec、任务上下文、工作区记忆以及平台感知的工作流连接。

Trellis 是否仅适用于 Claude Code？

不是。Trellis 目前支持 Claude Code、Cursor、OpenCode、iFlow、Codex、Kilo、Kiro、Gemini CLI、Antigravity、Windsurf、Qoder、CodeBuddy 和 GitHub Copilot。每种工具的详细设置和启动命令都收录在支持的平台指南中。

我是否必须手动编写每个 Spec 文件？

不必。许多团队会先让 AI 根据现有代码草拟 Spec，然后再手动调整关键部分。Trellis 的最佳使用方式是将高优先级规则明确列出并进行版本管理。

团队能否在不产生持续冲突的情况下使用它？

可以。每位开发者的个人工作区日志彼此独立，而共享的 Spec 和任务则保存在仓库中，可以像其他项目资产一样被审查和改进。

星级历史

社区与资源

• 官方文档 - 产品文档、设置指南和架构说明
• 快速入门 - 迅速在仓库中运行 Trellis
• 支持的平台 - 各平台特定的设置和命令详情
• 实际场景 - 了解工作流在实践中的运作方式
• 变更日志 - 跟踪当前版本及更新
• 技术博客 - 产品思考和技术文章
• GitHub 问题 - 报告 Bug 或请求功能
• Discord - 加入社区

官方仓库 • AGPL-3.0 许可证 • 由 Mindfold 构建

Trellis 快速上手指南

Trellis 是一个跨平台的 AI 编码框架，旨在统一不同 AI 编程工具（如 Claude Code、Cursor、GitHub Copilot 等）的工作流。它通过自动注入规范、任务中心化管理和多代理并行执行，让团队协作更高效。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：支持 macOS、Linux 和 Windows。
• 前置依赖：必须安装 Node.js (建议 LTS 版本) 和 npm。
• Git：确保已安装 Git 并配置好用户信息，因为 Trellis 依赖 Git Worktrees 进行多任务并行处理。
• AI 工具：根据需求预先安装至少一种支持的 AI 编码工具（如 Cursor、Claude Code 等）。

提示：国内开发者若遇到 npm 安装缓慢的问题，可临时切换至国内镜像源：

npm config set registry https://registry.npmmirror.com

安装步骤

使用 npm 全局安装 Trellis CLI 工具：

npm install -g @mindfoldhq/trellis@latest

安装完成后，可通过运行 trellis --version 验证安装是否成功。

基本使用

1. 初始化项目

进入你的代码仓库根目录，运行初始化命令。你需要指定一个用户名（用于创建个人工作空间日记）：

trellis init -u your-name

2. 指定 AI 平台（可选）

如果你只使用特定的 AI 工具，可以在初始化时直接声明，Trellis 会自动生成对应的配置文件（如 .cursorrules 或 .claude/ 等）：

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

支持的_platform 标志包括： --cursor, --opencode, --iflow, --codex, --kilo, --kiro, --gemini, --antigravity, --windsurf, --qoder, --codebuddy, --copilot 等。

3. 核心工作流

初始化后，项目根目录会生成 .trellis/ 文件夹，结构如下：

.trellis/
├── spec/                    # 存放项目规范、编码标准和模式（自动注入给 AI）
├── tasks/                   # 存放任务 PRD、上下文文件和状态
├── workspace/               # 存放个人日记和会话连续性记录 (your-name/)
├── workflow.md              # 团队共享的工作流规则
└── scripts/                 # 辅助脚本

最简单的使用场景：

1. 定义规范：在 .trellis/spec/ 中编写或修改 Markdown 文件，定义项目的代码风格和技术栈约束。
2. 创建任务：在 .trellis/tasks/ 中创建新任务的 PRD 文档。
3. 启动 AI：打开你配置的 AI 工具（如 Cursor），Trellis 会自动将相关规范和任务上下文注入到会话中，无需每次重复粘贴规则。
4. 并行开发：利用 trellis 配合 Git Worktrees，可以在不同分支同时运行多个 AI 任务而互不干扰。

4. 更新与同步

当框架更新或需要重新生成平台特定配置时，运行：

trellis update