跳转到主要内容

​
安装 Trellis

先全局安装 CLI： 
npm install -g @mindfoldhq/trellis@latest
然后在项目目录初始化： 
trellis init
Trellis 会用你的名字创建个人工作目录。如果不指定 -u，会自动从 git config user.name 获取。手动指定：trellis init -u john（把 john 换成你的名字）。

​
平台选择

默认 trellis init 为 Claude Code 配置。要包含其他平台： 
# 包含 Cursor 命令
trellis init --cursor

# 包含多个平台
trellis init --cursor --iflow

# 所有可用的平台选项
trellis init --claude     # Claude Code（默认）
trellis init --cursor     # Cursor IDE
trellis init --iflow      # iFlow CLI
trellis init --opencode   # OpenCode
trellis init --codex      # Codex（OpenAI CLI）

​
其他常用选项

trellis init -t electron-fullstack   # 使用规范模板
trellis init --overwrite             # 使用模板时覆盖已有 spec
trellis init --append                # 模板只补充缺失的文件

​
创建的目录结构

这会创建一个 .trellis/ 目录，结构如下： 
.trellis/
├── workflow.md          # 工作流说明
├── spec/                # 你的编码规范
│   ├── frontend/
│   ├── backend/
│   └── guides/
├── workspace/           # 会话日志
└── tasks/               # 任务跟踪
如果是 Claude Code 项目，还会配置 .claude/ 目录，包含 hooks 和命令。其他平台会创建对应的配置目录（.cursor/、.iflow/、.agents/ 等）。

​
更新 Trellis

新版本发布后： 
npm install -g @mindfoldhq/trellis@latest
trellis update
常用更新选项： 
trellis update --dry-run     # 预览变更，不实际应用
trellis update --force       # 覆盖所有管理的文件
trellis update --migrate     # 执行文件迁移（重命名、删除）
trellis update 只动没改过的文件，你的自定义不会丢。变更前会自动创建备份。

​
写第一个 Spec

打开 .trellis/spec/backend/index.md（如果主要写前端就打开 frontend/），填写模板。 一个真实的 spec 长这样： 
# 后端开发规范

## 错误处理

所有 API 接口返回错误时用这个格式：

{ "error": { "code": "VALIDATION_ERROR", "message": "邮箱不能为空" } }

使用 src/lib/errors.ts 里的 AppError 类。不要直接 throw Error 对象。

## 数据库

- 表名：snake_case，复数形式（user_sessions 而不是 UserSession）
- 必须包含 created_at 和 updated_at 时间戳
- 外键格式：{表名}\_id
写具体一点。带上文件路径。放项目里的真实代码。含糊的规范没用。

​
测试一下

开一个新的 Claude Code 会话，让它写点代码。检查它是不是遵循了你的规范。 如果没有，说明你的规范还不够具体。加更多例子进去。

​
接下来

核心概念

了解 Specs、Tasks 和 Workspace 是怎么配合工作的。

写好 Spec

让 AI 真正遵循规范的写作技巧。

命令参考

常用工作流的 Slash 命令。

多 Agent 协作

并行运行多个 AI Agent。