日常使用

./.trellis/scripts/multi-agent/plan.py \
  --name "feature-name" \
  --type "backend|frontend|fullstack" \
  --requirement "用户需求描述"

./.trellis/scripts/multi-agent/start.py "$TASK_DIR"

./.trellis/scripts/multi-agent/status.py                  # 概览
./.trellis/scripts/multi-agent/status.py --log <name>     # 查看日志
./.trellis/scripts/multi-agent/status.py --watch <name>   # 实时监控
./.trellis/scripts/multi-agent/cleanup.py <branch>        # 清理 worktree

./.trellis/scripts/add-session.py \
  --title "Session Title" \
  --commit "hash1,hash2" \
  --summary "本次完成了什么"

create → init-context → add-context → start → implement/check → finish → archive
  │           │              │           │          │               │         │
  │           │              │           │          │               │         │
  ▼           ▼              ▼           ▼          ▼               ▼         ▼
创建目录    初始化JSONL   添加上下文    设为当前     开发/检查      清除当前   归档到
task.json   配置文件      条目         任务指针     循环           任务      archive/

# 创建任务
TASK_DIR=$(./.trellis/scripts/task.py create "添加用户登录" \
  --slug user-login \          # 目录名后缀 (可选，否则自动 slugify)
  --assignee alice \           # 指派人 (可选)
  --priority P1 \              # 优先级: P0/P1/P2/P3 (可选，默认 P2)
  --description "实现JWT登录")  # 描述 (可选)

# 创建的目录: .trellis/tasks/02-27-user-login/
# 创建的文件: task.json

# 初始化 JSONL 配置
./.trellis/scripts/task.py init-context "$TASK_DIR" backend
# dev_type: backend | frontend | fullstack | test | docs
# 可选: --platform cursor (默认 claude)

# 添加额外上下文条目
./.trellis/scripts/task.py add-context "$TASK_DIR" implement \
  "src/services/auth.ts" "Existing auth patterns"
# 目标: implement | check | debug (简写，自动加 .jsonl)
# 会自动检测是文件还是目录

# 验证所有 JSONL 引用的文件是否存在
./.trellis/scripts/task.py validate "$TASK_DIR"

# 查看所有 JSONL 条目
./.trellis/scripts/task.py list-context "$TASK_DIR"

# 设为当前任务（Hook 会读取此指针进行注入）
./.trellis/scripts/task.py start "$TASK_DIR"

# 清除当前任务（无需参数，自动读取 .current-task）
./.trellis/scripts/task.py finish

# 设置 Git 分支名
./.trellis/scripts/task.py set-branch "$TASK_DIR" "feature/user-login"

# 设置 PR 目标分支
./.trellis/scripts/task.py set-base-branch "$TASK_DIR" "main"

# 设置 scope（用于 commit message: feat(scope): ...）
./.trellis/scripts/task.py set-scope "$TASK_DIR" "auth"

# 列出活跃任务
./.trellis/scripts/task.py list
./.trellis/scripts/task.py list --mine        # 只看自己的
./.trellis/scripts/task.py list --status review  # 按状态过滤

# 归档完成的任务
./.trellis/scripts/task.py archive user-login
# 移动到 archive/2026-02/

# 列出归档任务
./.trellis/scripts/task.py list-archive
./.trellis/scripts/task.py list-archive 2026-02  # 按月过滤

# 创建 PR（委托给 multi-agent/create-pr.py）
./.trellis/scripts/task.py create-pr

{
  "id": "02-27-user-login",
  "name": "user-login",
  "title": "添加用户登录",
  "description": "实现 JWT 登录流程",
  "status": "in_progress",
  "dev_type": "backend",
  "scope": "auth",
  "priority": "P1",
  "creator": "alice",
  "assignee": "alice",
  "createdAt": "2026-02-27T10:00:00Z",
  "completedAt": null,
  "branch": "feature/user-login",
  "base_branch": "main",
  "worktree_path": null,
  "current_phase": 1,
  "next_action": [
    { "phase": 1, "action": "implement" },
    { "phase": 2, "action": "check" },
    { "phase": 3, "action": "finish" },
    { "phase": 4, "action": "create-pr" }
  ],
  "commit": null,
  "pr_url": null,
  "subtasks": [],
  "relatedFiles": [],
  "notes": ""
}

planning → in_progress → review → completed
       ↘ rejected

{"file": ".trellis/workflow.md", "reason": "Project workflow and conventions"}
{"file": ".trellis/spec/shared/index.md", "reason": "Shared coding standards"}
{"file": ".trellis/spec/backend/index.md", "reason": "Backend development guide"}
{"file": ".trellis/spec/backend/api-module.md", "reason": "API module conventions"}
{"file": ".trellis/spec/backend/quality.md", "reason": "Code quality requirements"}

{"file": ".claude/commands/trellis/finish-work.md", "reason": "Finish work checklist"}
{"file": ".trellis/spec/shared/index.md", "reason": "Shared coding standards"}
{"file": ".claude/commands/trellis/check.md", "reason": "Backend check spec"}

# 添加现有代码作为参考（文件）
./.trellis/scripts/task.py add-context "$TASK_DIR" implement \
  "src/services/user.ts" "Existing user service patterns"

# 添加整个目录（自动读取所有 .md 文件）
./.trellis/scripts/task.py add-context "$TASK_DIR" implement \
  "src/services/" "Existing service patterns"

# 添加自定义 check 上下文
./.trellis/scripts/task.py add-context "$TASK_DIR" check \
  ".trellis/spec/guides/cross-layer-thinking-guide.md" "Cross-layer verification"

Input: "Add user authentication, authorization, password reset,
        2FA, OAuth integration, and audit logging"

=== PLAN REJECTED ===

Reason: Too Large / Should Be Split

Details:
This requirement bundles 6 distinct features:
1. User authentication (login/logout)
2. Authorization (roles/permissions)
3. Password reset flow
4. Two-factor authentication
5. OAuth integration
6. Audit logging

Suggestions:
- Start with basic authentication first
- Create separate features for each capability

my-monorepo/
├── packages/
│   ├── api/
│   ├── web/
│   └── shared/
└── .trellis/
    ├── spec/
    │   ├── api/         # API 包约定
    │   │   ├── backend/index.md
    │   │   └── ...
    │   ├── web/         # Web 包约定
    │   │   ├── frontend/index.md
    │   │   └── ...
    │   ├── shared/      # 共享包约定
    │   └── guides/      # 共享 thinking guides
    └── tasks/...

# 显式指定
python3 ./.trellis/scripts/task.py create "新增登录接口" \
  --slug add-login \
  --package api

# 生成目录：.trellis/tasks/MM-DD-add-login/（task.json.package = "api"）

python3 ./.trellis/scripts/task.py init-context "$TASK_DIR" backend --package api
# implement.jsonl 只写入 .trellis/spec/api/backend/* 相关条目

hooks:
  after_create:
    - 'python3 .trellis/scripts/hooks/linear_sync.py create'
  after_start:
    - 'python3 .trellis/scripts/hooks/linear_sync.py start'
  after_finish:
    - "echo 'Task finished'"
  after_archive:
    - 'python3 .trellis/scripts/hooks/linear_sync.py archive'

{
  "linear": {
    "team": "ENG",
    "project": "My Project",
    "assignees": {
      "alice": "linear-user-id-for-alice"
    }
  }
}

.trellis/spec/
├── frontend/                    # 前端规范
│   ├── index.md                 #   索引：列出所有规范及状态
│   ├── component-guidelines.md  #   组件规范
│   ├── hook-guidelines.md       #   Hook 规范
│   ├── state-management.md      #   状态管理
│   ├── type-safety.md           #   类型安全
│   ├── quality-guidelines.md    #   质量指南
│   └── directory-structure.md   #   目录结构
│
├── backend/                     # 后端规范
│   ├── index.md
│   ├── database-guidelines.md
│   ├── error-handling.md
│   ├── logging-guidelines.md
│   ├── quality-guidelines.md
│   └── directory-structure.md
│
└── guides/                      # 思维指南
    ├── index.md
    ├── cross-layer-thinking-guide.md
    └── code-reuse-thinking-guide.md

# 看看现有代码是怎么组织的
ls src/components/     # 组件结构
ls src/services/       # 服务结构

# Component Guidelines

## File Structure

- One component per file
- Use PascalCase for filenames: `UserProfile.tsx`
- Co-locate styles: `UserProfile.module.css`
- Co-locate tests: `UserProfile.test.tsx`

## Patterns

### Required

- Functional components + hooks (no class components)
- TypeScript with explicit Props interface
- `export default` for page components, named export for shared

### Forbidden

- No `any` type in Props
- No inline styles (use CSS Modules)
- No direct DOM manipulation

### Good Example

```tsx
interface UserProfileProps {
  userId: string;
  onUpdate: (user: User) => void;
}

export function UserProfile({ userId, onUpdate }: UserProfileProps) {
  // ...
}

// Don't: no Props interface, using any
export default function UserProfile(props: any) {
  // ...
}

**Step 4**：更新 index.md 状态

```markdown
| Guideline | File | Status |
|-----------|------|--------|
| Component Guidelines | component-guidelines.md | **Filled** |
| Hook Guidelines | hook-guidelines.md | To fill |

### Database Query Pattern

**Always use parameterized queries** to prevent SQL injection.

```sql
-- Good
SELECT * FROM users WHERE id = $1

-- Bad
SELECT * FROM users WHERE id = '${userId}'

**差的规范**（太模糊、没代码、没原因）：

```markdown
### Database
- Use good query patterns
- Be careful with SQL
- Follow best practices

### Variable Naming
- All boolean variables must start with `is` or `has`
- All arrays must end with `List`
- All functions must be less than 20 lines
- All files must be less than 200 lines

开发 → 发现模式/问题 → 手动更新 Spec 文件 → git push
                                                   ↓
  全员受益 ← Hook 自动注入 ← 下次会话自动加载 ← git pull

# 1. 启动并行模式
/parallel

# 2. 描述需求
"我需要并行开发三个功能：
1. 用户个人资料页面
2. 邮件通知系统
3. 数据导出功能"

# 3. AI 自动为每个功能创建 worktree 并启动 Agent

# 4. 监控进度
./.trellis/scripts/multi-agent/status.py
# Task 1: user-profile     ✅ Complete (PR #123)
# Task 2: email-notify     🔄 In Progress (Check phase)
# Task 3: data-export      🔄 In Progress (Implement phase)

# 5. 审查并合并 PR

# 6. 清理 worktree
./.trellis/scripts/multi-agent/cleanup.py user-profile

# ✅ Database Layer: comments table created
# ✅ API Layer: POST /api/comments endpoint
# ✅ UI Layer: CommentForm component
# ✅ Data Flow: UI → API → DB ✓

# 6. 测试、提交、记录

# Alice 开发并总结规范（以 Claude Code 为例，Cursor 用 /start）
trellis init -u alice
/start
# ... 开发认证系统 ...
# 将 auth 相关最佳实践手动写入 spec
git add .trellis/spec/
git commit -m "docs: add auth guidelines"
git push

# Bob 拉取后自动受益
git pull
trellis init -u bob
/start
"添加权限管理"
# AI 自动读取 Alice 写的 auth guidelines
# Bob 的代码自动遵循 Alice 的规范

# 1. 启动
/start

# 2. 修 bug
"用户在某些情况下无法登录"

# 3. AI 调试修复...

# 4. 深度分析
/break-loop

# AI 输出：
# Root Cause: B - Cross-layer Contract Violation
#   前端发送的 token 格式和后端期望的不一致
#
# Prevention:
#   - 更新 spec: 定义 token 格式契约
#   - 添加类型约束: 共享 Token interface
#   - 添加测试: token 格式验证

# 5. 手动更新 spec
# 将 token 格式契约写入 .trellis/spec/ 文件

# 发现模式
# AI 在开发中发现：所有 API 错误都应该返回统一格式
# { error: string, code: number, details?: any }

# 手动更新 spec
# 将这个模式写入 .trellis/spec/backend/error-handling.md

# 下次任何人做 API 开发
# Hook 自动注入 error-handling.md
# AI 自动遵循统一错误格式
# → 所有 API 错误格式一致

# 1. 创建项目
mkdir my-app && cd my-app
git init

# 2. 安装 Trellis
npm install -g @mindfoldhq/trellis@latest
trellis init -u your-name

# 3. trellis init 已自动创建 bootstrap 引导任务（00-bootstrap-guidelines）
/start
# AI 会自动检测 bootstrap 任务，分析你的代码库并帮你填充 spec

# 4. 手动补充核心规范
# 编辑 .trellis/spec/backend/index.md 等
# 写下你的技术栈选择、编码约定、目录结构

# 5. 开始开发
/start
"搭建项目基础架构"