跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.trytrellis.app/llms.txt

Use this file to discover all available pages before exploring further.

Trellis 是什么?

AI 的能力像藤蔓一样生长,充满活力但四处蔓延。Trellis 是 AI 的脚手架,引导它沿着规范的路径前进。 支持平台:Claude Code、Cursor、OpenCode、Codex、Kiro、Kilo、Gemini CLI、Antigravity、Windsurf、Qoder、CodeBuddy、GitHub Copilot、Droid、Pi Agent,以及任何读取 .agents/skills/ 规范的 agent(Amp、Cline、Deep Agents、Firebender、Kimi Code CLI、Warp 等)。

一句话定位

Trellis 是 AI 编码助手的辅助轮:通过自动化机制注入项目规范,让 AI 每次都按你的标准写代码,而不是随机发挥。
AI’s capabilities grow like vines, full of vitality but spreading everywhere. Trellis is scaffolding for AI, guiding it along the path of your conventions.

vs 传统方法对比

维度.cursorrulesCLAUDE.mdSkillsTrellis
规范注入方式每次对话手动加载自动加载但容易被截断用户主动调用自动注入(支持 hook 的平台用 hook,其他平台用 prelude),按任务精准加载
规范粒度一个大文件一个大文件每个 Skill 独立按模块分文件,按任务组合
跨会话记忆workspace journal 持久化
工作流固化Auto-trigger skill + check sub-agent 验证循环
团队共享单人单人可分享但无标准Git 版本化 Spec 库
支持平台Cursor 专属Claude Code 专属按平台14 个已配置平台 + 共享 skill 生态

核心概念速览

概念说明存放位置
Spec(规范)你的编码标准,用 Markdown 写成。AI 写代码前先读规范.trellis/spec/
Workspace(工作区)每个开发者的会话日志,让 AI 记住上次做了什么.trellis/workspace/
Task(任务)工作单元,包含需求文档和上下文配置.trellis/tasks/
Skill(技能)Auto-trigger 工作流模块:brainstorm / before-dev / check / update-spec / break-loop各平台的 skills 目录
Sub-agent(子代理)专门角色的 AI 子进程:trellis-researchtrellis-implementtrellis-check各平台的 agents 目录
Command(命令)显式会话入口:finish-workcontinue,以及需要手动入口的平台上的 start各平台的 commands 目录
Hook(钩子)自动触发的脚本,在会话启动、sub-agent 调用等时机注入上下文(支持 hook 的平台).claude/hooks/
Journal(日志)会话记录文件,记录每次开发做了什么.trellis/workspace/{name}/journal-N.md

为什么用 Trellis?

功能解决什么问题
自动注入规范和工作流自动注入每次对话,写一次,永久生效
自更新规范库最佳实践存在自更新的 spec 文件中,用得越多,AI 越懂你
Skill 优先大部分操作是 auto-trigger 的 skill,AI 自己挑正确的那个,不用手动敲命令
团队共享团队共享规范,团队里有一个高人搞一版好的规范,拉高全员的 AI coding 水平
会话持久化工作记录持久化到仓库,AI 跨会话记住项目上下文,不用每次再费劲告诉 AI 你的项目情况是什么

快速开始

5 分钟安装 Trellis,搭建你的第一个项目。

架构全景

了解 Specs、Tasks、Hook 和 Workspace。

命令与 Skill

Slash 命令(/start/finish-work)和 auto-trigger skill 参考。

规范编写

trellis-update-spec 把空模板变成可执行契约。