chore: migrate from opencode to trellis 0.5.0-rc.6
- Remove legacy .opencode/ directory and configuration - Update .trellis/ to v0.5.0-rc.6 structure - Refactor scripts: modularize common/, remove multi_agent/ - Add new common modules: git.py, io.py, log.py, types.py, etc. - Update workflow.md and AGENTS.md - Archive completed migration tasks
This commit is contained in:
zl-q
@@ -0,0 +1,94 @@
|
||||
---
|
||||
name: trellis-check
|
||||
description: |
|
||||
Code quality check expert. Reviews code changes against specs and self-fixes issues.
|
||||
tools: Read, Write, Edit, Bash, Glob, Grep, mcp__exa__web_search_exa, mcp__exa__get_code_context_exa
|
||||
---
|
||||
# Check Agent
|
||||
|
||||
You are the Check Agent in the Trellis workflow.
|
||||
|
||||
## Context
|
||||
|
||||
Before checking, read:
|
||||
- `.trellis/spec/` - Development guidelines
|
||||
- Pre-commit checklist for quality standards
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
1. **Get code changes** - Use git diff to get uncommitted code
|
||||
2. **Check against specs** - Verify code follows guidelines
|
||||
3. **Self-fix** - Fix issues yourself, not just report them
|
||||
4. **Run verification** - typecheck and lint
|
||||
|
||||
## Important
|
||||
|
||||
**Fix issues yourself**, don't just report them.
|
||||
|
||||
You have write and edit tools, you can modify code directly.
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Get Changes
|
||||
|
||||
```bash
|
||||
git diff --name-only # List changed files
|
||||
git diff # View specific changes
|
||||
```
|
||||
|
||||
### Step 2: Check Against Specs
|
||||
|
||||
Read relevant specs in `.trellis/spec/` to check code:
|
||||
|
||||
- Does it follow directory structure conventions
|
||||
- Does it follow naming conventions
|
||||
- Does it follow code patterns
|
||||
- Are there missing types
|
||||
- Are there potential bugs
|
||||
|
||||
### Step 3: Self-Fix
|
||||
|
||||
After finding issues:
|
||||
|
||||
1. Fix the issue directly (use edit tool)
|
||||
2. Record what was fixed
|
||||
3. Continue checking other issues
|
||||
|
||||
### Step 4: Run Verification
|
||||
|
||||
Run project's lint and typecheck commands to verify changes.
|
||||
|
||||
If failed, fix issues and re-run.
|
||||
|
||||
---
|
||||
|
||||
## Report Format
|
||||
|
||||
```markdown
|
||||
## Self-Check Complete
|
||||
|
||||
### Files Checked
|
||||
|
||||
- src/components/Feature.tsx
|
||||
- src/hooks/useFeature.ts
|
||||
|
||||
### Issues Found and Fixed
|
||||
|
||||
1. `<file>:<line>` - <what was fixed>
|
||||
2. `<file>:<line>` - <what was fixed>
|
||||
|
||||
### Issues Not Fixed
|
||||
|
||||
(If there are issues that cannot be self-fixed, list them here with reasons)
|
||||
|
||||
### Verification Results
|
||||
|
||||
- TypeCheck: Passed
|
||||
- Lint: Passed
|
||||
|
||||
### Summary
|
||||
|
||||
Checked X files, found Y issues, all fixed.
|
||||
```
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
name: trellis-implement
|
||||
description: |
|
||||
Code implementation expert. Understands specs and requirements, then implements features. No git commit allowed.
|
||||
tools: Read, Write, Edit, Bash, Glob, Grep, mcp__exa__web_search_exa, mcp__exa__get_code_context_exa
|
||||
---
|
||||
# Implement Agent
|
||||
|
||||
You are the Implement Agent in the Trellis workflow.
|
||||
|
||||
## Context
|
||||
|
||||
Before implementing, read:
|
||||
- `.trellis/workflow.md` - Project workflow
|
||||
- `.trellis/spec/` - Development guidelines
|
||||
- Task `prd.md` - Requirements document
|
||||
- Task `info.md` - Technical design (if exists)
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
1. **Understand specs** - Read relevant spec files in `.trellis/spec/`
|
||||
2. **Understand requirements** - Read prd.md and info.md
|
||||
3. **Implement features** - Write code following specs and design
|
||||
4. **Self-check** - Ensure code quality
|
||||
5. **Report results** - Report completion status
|
||||
|
||||
## Forbidden Operations
|
||||
|
||||
**Do NOT execute these git commands:**
|
||||
|
||||
- `git commit`
|
||||
- `git push`
|
||||
- `git merge`
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
### 1. Understand Specs
|
||||
|
||||
Read relevant specs based on task type:
|
||||
|
||||
- Spec layers: `.trellis/spec/<package>/<layer>/`
|
||||
- Shared guides: `.trellis/spec/guides/`
|
||||
|
||||
### 2. Understand Requirements
|
||||
|
||||
Read the task's prd.md and info.md:
|
||||
|
||||
- What are the core requirements
|
||||
- Key points of technical design
|
||||
- Which files to modify/create
|
||||
|
||||
### 3. Implement Features
|
||||
|
||||
- Write code following specs and technical design
|
||||
- Follow existing code patterns
|
||||
- Only do what's required, no over-engineering
|
||||
|
||||
### 4. Verify
|
||||
|
||||
Run project's lint and typecheck commands to verify changes.
|
||||
|
||||
---
|
||||
|
||||
## Report Format
|
||||
|
||||
```markdown
|
||||
## Implementation Complete
|
||||
|
||||
### Files Modified
|
||||
|
||||
- `src/components/Feature.tsx` - New component
|
||||
- `src/hooks/useFeature.ts` - New hook
|
||||
|
||||
### Implementation Summary
|
||||
|
||||
1. Created Feature component...
|
||||
2. Added useFeature hook...
|
||||
|
||||
### Verification Results
|
||||
|
||||
- Lint: Passed
|
||||
- TypeCheck: Passed
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Code Standards
|
||||
|
||||
- Follow existing code patterns
|
||||
- Don't add unnecessary abstractions
|
||||
- Only do what's required, no over-engineering
|
||||
- Keep code readable
|
||||
@@ -0,0 +1,137 @@
|
||||
---
|
||||
name: trellis-research
|
||||
description: |
|
||||
Code and tech search expert. Finds files, patterns, and tech solutions, and PERSISTS every finding to the current task's research/ directory. No code modifications outside that directory.
|
||||
tools: Read, Write, Glob, Grep, Bash, mcp__exa__web_search_exa, mcp__exa__get_code_context_exa, Skill, mcp__chrome-devtools__*
|
||||
---
|
||||
# Research Agent
|
||||
|
||||
You are the Research Agent in the Trellis workflow.
|
||||
|
||||
## Core Principle
|
||||
|
||||
**You do one thing: find, explain, and PERSIST information.**
|
||||
|
||||
Conversations get compacted; files don't. Every research output MUST end up as a file under `{TASK_DIR}/research/`. Returning findings only through the chat reply is a failure — the caller cannot read them next session.
|
||||
|
||||
---
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
1. **Internal Search** — locate files/components, understand code logic, discover patterns (Glob, Grep, Read)
|
||||
2. **External Search** — library docs, API references, best practices (web search)
|
||||
3. **Persist** — write each research topic to `{TASK_DIR}/research/<topic>.md`
|
||||
4. **Report** — return file paths + one-line summaries to the main agent (not full content)
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Resolve Current Task
|
||||
|
||||
Run `python3 ./.trellis/scripts/task.py current --source` → active task path. If no active task is set, ask the user where to write output; do NOT guess.
|
||||
|
||||
Ensure `{TASK_DIR}/research/` exists:
|
||||
|
||||
```bash
|
||||
mkdir -p <TASK_DIR>/research
|
||||
```
|
||||
|
||||
### Step 2: Understand Search Request
|
||||
|
||||
Classify: internal / external / mixed. Determine scope (global / specific directory) and expected shape (file list / pattern notes / tech comparison).
|
||||
|
||||
### Step 3: Execute Search
|
||||
|
||||
Run independent searches in parallel (Glob + Grep + web) for efficiency.
|
||||
|
||||
### Step 4: Persist Each Topic
|
||||
|
||||
For each distinct research topic, Write a markdown file at `{TASK_DIR}/research/<topic-slug>.md`. Use the File Format below.
|
||||
|
||||
### Step 5: Report to Main Agent
|
||||
|
||||
Reply with ONLY:
|
||||
|
||||
- List of files written (paths relative to repo root)
|
||||
- One-line summary per file
|
||||
- Any critical caveats that the main agent needs to know right now
|
||||
|
||||
Do NOT paste full research content into the reply. The files are the contract.
|
||||
|
||||
---
|
||||
|
||||
## Scope Limits (Strict)
|
||||
|
||||
### Write ALLOWED
|
||||
|
||||
- `{TASK_DIR}/research/*.md` — your own output
|
||||
- Creating `{TASK_DIR}/research/` if it doesn't exist (via `mkdir -p`)
|
||||
|
||||
### Write FORBIDDEN
|
||||
|
||||
- Code files (`src/`, `lib/`, …)
|
||||
- Spec files (`.trellis/spec/`) — main agent should use `update-spec` skill instead
|
||||
- `.trellis/scripts/`, `.trellis/workflow.md`, platform config (`.claude/`, `.cursor/`, etc.)
|
||||
- Other task directories
|
||||
- Any git operation (commit / push / branch / merge)
|
||||
|
||||
If the user asks you to edit code, decline and suggest spawning `implement` instead.
|
||||
|
||||
---
|
||||
|
||||
## File Format
|
||||
|
||||
Each `{TASK_DIR}/research/<topic>.md` should follow:
|
||||
|
||||
```markdown
|
||||
# Research: <topic>
|
||||
|
||||
- **Query**: <original query>
|
||||
- **Scope**: <internal / external / mixed>
|
||||
- **Date**: <YYYY-MM-DD>
|
||||
|
||||
## Findings
|
||||
|
||||
### Files Found
|
||||
|
||||
| File Path | Description |
|
||||
|---|---|
|
||||
| `src/services/xxx.ts` | Main implementation |
|
||||
| `src/types/xxx.ts` | Type definitions |
|
||||
|
||||
### Code Patterns
|
||||
|
||||
<describe patterns, cite file:line>
|
||||
|
||||
### External References
|
||||
|
||||
- [Library X docs](url) — <why relevant, version constraints>
|
||||
|
||||
### Related Specs
|
||||
|
||||
- `.trellis/spec/xxx.md` — <description>
|
||||
|
||||
## Caveats / Not Found
|
||||
|
||||
<anything incomplete or uncertain>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Guidelines
|
||||
|
||||
### DO
|
||||
|
||||
- Provide specific file paths and line numbers
|
||||
- Quote actual code snippets
|
||||
- Persist every topic to its own file
|
||||
- Return file paths in your reply, not the full content
|
||||
- Mark "not found" explicitly when searches come up empty
|
||||
|
||||
### DON'T
|
||||
|
||||
- Don't write code or modify files outside `{TASK_DIR}/research/`
|
||||
- Don't guess uncertain info
|
||||
- Don't paste full research text into the reply (files are the deliverable)
|
||||
- Don't propose improvements or critique implementation (that's not your role)
|
||||
@@ -0,0 +1,55 @@
|
||||
# Continue Current Task
|
||||
|
||||
Resume work on the current task — pick up at the right phase/step in `.trellis/workflow.md`.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Load Current Context
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py
|
||||
```
|
||||
|
||||
Confirms: current task, git state, recent commits.
|
||||
|
||||
## Step 2: Load the Phase Index
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode phase
|
||||
```
|
||||
|
||||
Shows the Phase Index (Plan / Execute / Finish) with routing + skill mapping.
|
||||
|
||||
## Step 3: Decide Where You Are
|
||||
|
||||
`get_context.py` shows the active task's `status` field. Route by `status` + artifact presence:
|
||||
|
||||
- `status=planning` + no `prd.md` → **1.1** (load `trellis-brainstorm`)
|
||||
- `status=planning` + `prd.md` exists + `implement.jsonl` not curated (only the seed `_example` row) → **1.3**
|
||||
- `status=planning` + `prd.md` + curated `implement.jsonl` → **1.4** (run `task.py start` to enter Phase 2)
|
||||
- `status=in_progress` + implementation not started → **2.1**
|
||||
- `status=in_progress` + implementation done, not yet checked → **2.2**
|
||||
- `status=in_progress` + check passed → **3.1**
|
||||
- `status=completed` (rare; usually archived immediately) → archive flow
|
||||
|
||||
Phase rules (full detail in `.trellis/workflow.md`):
|
||||
|
||||
1. Run steps **in order** within a phase — `[required]` steps must not be skipped
|
||||
2. `[once]` steps are already done if the output exists (e.g., `prd.md` for 1.1; `implement.jsonl` with curated entries for 1.3) — skip them
|
||||
3. You may go back to an earlier phase if discoveries require it
|
||||
|
||||
## Step 4: Load the Specific Step
|
||||
|
||||
Once you know which step to resume at:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode phase --step <X.X> --platform claude
|
||||
```
|
||||
|
||||
Follow the loaded instructions. After each `[required]` step completes, move to the next.
|
||||
|
||||
---
|
||||
|
||||
## Reference
|
||||
|
||||
Full workflow, skill routing table, and the DO-NOT-skip table live in `.trellis/workflow.md`. This command is only an entry point — the canonical guidance is there.
|
||||
@@ -0,0 +1,66 @@
|
||||
# Finish Work
|
||||
|
||||
Wrap up the current session: archive the active task (and any other completed-but-unarchived tasks the user wants to clean up) and record the session journal. Code commits are NOT done here — those happen in workflow Phase 3.4 before you invoke this command.
|
||||
|
||||
## Step 1: Survey current state
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode record
|
||||
```
|
||||
|
||||
This prints:
|
||||
|
||||
- **My active tasks** — review whether any besides the current one are actually done (code merged, AC met) and should be archived this round.
|
||||
- **Git status** — quick visual on what's dirty.
|
||||
- **Recent commits** — you'll need their hashes in Step 4 for `--commit`.
|
||||
|
||||
If `--mode record` surfaces other completed tasks not tied to the current session, surface them to the user with a one-shot confirmation: "These N tasks look done — archive them too in this round? [y/N]". Default is no; the current active task is always archived in Step 3 regardless.
|
||||
|
||||
## Step 2: Sanity check — classify dirty paths
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
git status --porcelain
|
||||
```
|
||||
|
||||
Filter out paths under `.trellis/workspace/` and `.trellis/tasks/` — those are managed by `add_session.py` and `task.py archive` auto-commits and will appear dirty as part of this skill's own work.
|
||||
|
||||
For each remaining dirty path, decide whether it belongs to **the current task** or to **other parallel work** (e.g., another terminal window editing the same repo). Heuristics:
|
||||
|
||||
- Paths referenced in the current task's `prd.md` / `implement.jsonl` / `check.jsonl` → current task
|
||||
- Paths in code areas matching the task's stated scope, or that you remember editing this session → current task
|
||||
- Paths in unrelated areas you have no recollection of touching this session → other parallel work
|
||||
|
||||
Then route:
|
||||
|
||||
- **Any remaining path looks like current-task work** — bail out with:
|
||||
> "Working tree has uncommitted code changes from this task: `<list>`. Return to workflow Phase 3.4 to commit them before running `/trellis:finish-work`."
|
||||
|
||||
Do NOT run `git commit` here. Do NOT prompt the user to commit. The user goes back to Phase 3.4 and the AI drives the batched commit there.
|
||||
- **All remaining paths look unrelated** (other parallel-window work) — report them once and continue to Step 3:
|
||||
> "FYI, dirty files outside this task's scope — leaving them for the other window: `<list>`."
|
||||
- **Genuinely unsure** — ask the user once: "Are `<list>` this task's work I forgot to commit, or another window's? (commit / ignore)" — then route per their answer.
|
||||
|
||||
## Step 3: Archive task(s)
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py archive <task-name>
|
||||
```
|
||||
|
||||
At minimum: the current active task (if any). Plus any extra tasks the user confirmed in Step 1. Each archive produces a `chore(task): archive ...` commit via the script's auto-commit.
|
||||
|
||||
If there is no active task and the user did not confirm any cleanup archives, skip this step.
|
||||
|
||||
## Step 4: Record session journal
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/add_session.py \
|
||||
--title "Session Title" \
|
||||
--commit "hash1,hash2" \
|
||||
--summary "Brief summary"
|
||||
```
|
||||
|
||||
Use the work-commit hashes produced in Phase 3.4 (visible in Step 1's `Recent commits` list, or via `git log --oneline`) for `--commit`. Do not include the archive commit hashes from Step 3. This produces a `chore: record journal` commit.
|
||||
|
||||
Final git log order: `<work commits from 3.4>` → `chore(task): archive ...` (one or more) → `chore: record journal`.
|
||||
Executable
+746
@@ -0,0 +1,746 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Multi-Platform Sub-Agent Context Injection Hook
|
||||
|
||||
Injects task-specific context when sub-agents (implement, check, research) are spawned.
|
||||
|
||||
Core Design Philosophy:
|
||||
- Hook is responsible for injecting all context, subagent works autonomously with complete info
|
||||
- Each agent has a dedicated jsonl file defining its context
|
||||
- No resume needed, no segmentation, behavior controlled by code not prompt
|
||||
|
||||
Trigger: PreToolUse (before Task tool call)
|
||||
|
||||
Context Source: Trellis active task resolver points to task directory
|
||||
- implement.jsonl - Implement agent dedicated context
|
||||
- check.jsonl - Check agent dedicated context
|
||||
- prd.md - Requirements document
|
||||
- info.md - Technical design
|
||||
- codex-review-output.txt - Code Review results
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
# IMPORTANT: Suppress all warnings FIRST
|
||||
import warnings
|
||||
warnings.filterwarnings("ignore")
|
||||
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
# IMPORTANT: Force stdout to use UTF-8 on Windows
|
||||
# This fixes UnicodeEncodeError when outputting non-ASCII characters
|
||||
if sys.platform.startswith("win"):
|
||||
import io as _io
|
||||
if hasattr(sys.stdout, "reconfigure"):
|
||||
sys.stdout.reconfigure(encoding="utf-8", errors="replace") # type: ignore[union-attr]
|
||||
elif hasattr(sys.stdout, "detach"):
|
||||
sys.stdout = _io.TextIOWrapper(sys.stdout.detach(), encoding="utf-8", errors="replace") # type: ignore[union-attr]
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# Path Constants (change here to rename directories)
|
||||
# =============================================================================
|
||||
|
||||
DIR_WORKFLOW = ".trellis"
|
||||
DIR_SPEC = "spec"
|
||||
FILE_TASK_JSON = "task.json"
|
||||
|
||||
# =============================================================================
|
||||
# Subagent Constants (change here to rename subagent types)
|
||||
# =============================================================================
|
||||
|
||||
AGENT_IMPLEMENT = "trellis-implement"
|
||||
AGENT_CHECK = "trellis-check"
|
||||
AGENT_RESEARCH = "trellis-research"
|
||||
|
||||
# Agents that require a task directory
|
||||
AGENTS_REQUIRE_TASK = (AGENT_IMPLEMENT, AGENT_CHECK)
|
||||
# All supported agents
|
||||
AGENTS_ALL = (AGENT_IMPLEMENT, AGENT_CHECK, AGENT_RESEARCH)
|
||||
|
||||
|
||||
def find_repo_root(start_path: str) -> str | None:
|
||||
"""
|
||||
Find git repo root from start_path upwards
|
||||
|
||||
Returns:
|
||||
Repo root path, or None if not found
|
||||
"""
|
||||
current = Path(start_path).resolve()
|
||||
while current != current.parent:
|
||||
if (current / ".git").exists():
|
||||
return str(current)
|
||||
current = current.parent
|
||||
return None
|
||||
|
||||
|
||||
def _detect_platform(input_data: dict) -> str | None:
|
||||
if isinstance(input_data.get("cursor_version"), str):
|
||||
return "cursor"
|
||||
env_map = {
|
||||
"CLAUDE_PROJECT_DIR": "claude",
|
||||
"CURSOR_PROJECT_DIR": "cursor",
|
||||
"CODEBUDDY_PROJECT_DIR": "codebuddy",
|
||||
"FACTORY_PROJECT_DIR": "droid",
|
||||
"GEMINI_PROJECT_DIR": "gemini",
|
||||
"QODER_PROJECT_DIR": "qoder",
|
||||
"KIRO_PROJECT_DIR": "kiro",
|
||||
"COPILOT_PROJECT_DIR": "copilot",
|
||||
}
|
||||
for env_name, platform in env_map.items():
|
||||
if os.environ.get(env_name):
|
||||
return platform
|
||||
script_parts = set(Path(sys.argv[0]).parts)
|
||||
if ".claude" in script_parts:
|
||||
return "claude"
|
||||
if ".cursor" in script_parts:
|
||||
return "cursor"
|
||||
if ".gemini" in script_parts:
|
||||
return "gemini"
|
||||
if ".qoder" in script_parts:
|
||||
return "qoder"
|
||||
if ".codebuddy" in script_parts:
|
||||
return "codebuddy"
|
||||
if ".factory" in script_parts:
|
||||
return "droid"
|
||||
if ".kiro" in script_parts:
|
||||
return "kiro"
|
||||
return None
|
||||
|
||||
|
||||
def get_current_task(repo_root: str, input_data: dict) -> str | None:
|
||||
"""Resolve current task directory through the unified active task resolver."""
|
||||
scripts_dir = Path(repo_root) / DIR_WORKFLOW / "scripts"
|
||||
if str(scripts_dir) not in sys.path:
|
||||
sys.path.insert(0, str(scripts_dir))
|
||||
try:
|
||||
from common.active_task import resolve_active_task # type: ignore[import-not-found]
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
active = resolve_active_task(
|
||||
Path(repo_root),
|
||||
input_data,
|
||||
platform=_detect_platform(input_data),
|
||||
)
|
||||
return active.task_path
|
||||
|
||||
|
||||
def read_file_content(base_path: str, file_path: str) -> str | None:
|
||||
"""Read file content, return None if file doesn't exist"""
|
||||
full_path = os.path.join(base_path, file_path)
|
||||
if os.path.exists(full_path) and os.path.isfile(full_path):
|
||||
try:
|
||||
with open(full_path, "r", encoding="utf-8") as f:
|
||||
return f.read()
|
||||
except Exception:
|
||||
return None
|
||||
return None
|
||||
|
||||
|
||||
def read_directory_contents(
|
||||
base_path: str, dir_path: str, max_files: int = 20
|
||||
) -> list[tuple[str, str]]:
|
||||
"""
|
||||
Read all .md files in a directory
|
||||
|
||||
Args:
|
||||
base_path: Base path (usually repo_root)
|
||||
dir_path: Directory relative path
|
||||
max_files: Max files to read (prevent huge directories)
|
||||
|
||||
Returns:
|
||||
[(file_path, content), ...]
|
||||
"""
|
||||
full_path = os.path.join(base_path, dir_path)
|
||||
if not os.path.exists(full_path) or not os.path.isdir(full_path):
|
||||
return []
|
||||
|
||||
results = []
|
||||
try:
|
||||
# Only read .md files, sorted by filename
|
||||
md_files = sorted(
|
||||
[
|
||||
f
|
||||
for f in os.listdir(full_path)
|
||||
if f.endswith(".md") and os.path.isfile(os.path.join(full_path, f))
|
||||
]
|
||||
)
|
||||
|
||||
for filename in md_files[:max_files]:
|
||||
file_full_path = os.path.join(full_path, filename)
|
||||
relative_path = os.path.join(dir_path, filename)
|
||||
try:
|
||||
with open(file_full_path, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
results.append((relative_path, content))
|
||||
except Exception:
|
||||
continue
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return results
|
||||
|
||||
|
||||
def read_jsonl_entries(base_path: str, jsonl_path: str) -> list[tuple[str, str]]:
|
||||
"""
|
||||
Read all file/directory contents referenced in jsonl file
|
||||
|
||||
Schema:
|
||||
{"file": "path/to/file.md", "reason": "..."}
|
||||
{"file": "path/to/dir/", "type": "directory", "reason": "..."}
|
||||
{"_example": "..."} # seed row — skipped (no `file` field)
|
||||
|
||||
Rows without a ``file`` field (e.g. the self-describing seed line written
|
||||
by ``task.py create`` before the agent has curated entries) are skipped
|
||||
silently. If the resulting entry list is empty, a stderr warning is
|
||||
emitted so the operator can debug missing context.
|
||||
|
||||
Returns:
|
||||
[(path, content), ...]
|
||||
"""
|
||||
full_path = os.path.join(base_path, jsonl_path)
|
||||
if not os.path.exists(full_path):
|
||||
print(
|
||||
f"[inject-subagent-context] WARN: {jsonl_path} not found — "
|
||||
f"sub-agent will receive only prd.md",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return []
|
||||
|
||||
results = []
|
||||
saw_real_entry = False
|
||||
try:
|
||||
with open(full_path, "r", encoding="utf-8") as f:
|
||||
for line in f:
|
||||
line = line.strip()
|
||||
if not line:
|
||||
continue
|
||||
try:
|
||||
item = json.loads(line)
|
||||
file_path = item.get("file") or item.get("path")
|
||||
entry_type = item.get("type", "file")
|
||||
|
||||
if not file_path:
|
||||
# Seed / comment row — skip silently
|
||||
continue
|
||||
|
||||
saw_real_entry = True
|
||||
if entry_type == "directory":
|
||||
# Read all .md files in directory
|
||||
dir_contents = read_directory_contents(base_path, file_path)
|
||||
results.extend(dir_contents)
|
||||
else:
|
||||
# Read single file
|
||||
content = read_file_content(base_path, file_path)
|
||||
if content:
|
||||
results.append((file_path, content))
|
||||
except json.JSONDecodeError:
|
||||
continue
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
if not saw_real_entry:
|
||||
print(
|
||||
f"[inject-subagent-context] WARN: {jsonl_path} has no curated "
|
||||
f"entries (only seed / empty) — sub-agent will receive only "
|
||||
f"prd.md. See workflow.md Phase 1.3 for curation guidance.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
return results
|
||||
|
||||
|
||||
|
||||
|
||||
def get_agent_context(repo_root: str, task_dir: str, agent_type: str) -> str:
|
||||
"""
|
||||
Get context from {agent_type}.jsonl for the specified agent.
|
||||
Only reads implement.jsonl or check.jsonl (the two JSONL files the task system creates).
|
||||
"""
|
||||
context_parts = []
|
||||
|
||||
agent_jsonl = f"{task_dir}/{agent_type}.jsonl"
|
||||
for file_path, content in read_jsonl_entries(repo_root, agent_jsonl):
|
||||
context_parts.append(f"=== {file_path} ===\n{content}")
|
||||
|
||||
return "\n\n".join(context_parts)
|
||||
|
||||
|
||||
def get_implement_context(repo_root: str, task_dir: str) -> str:
|
||||
"""
|
||||
Complete context for Implement Agent
|
||||
|
||||
Read order:
|
||||
1. All files in implement.jsonl (dev specs)
|
||||
2. prd.md (requirements)
|
||||
3. info.md (technical design)
|
||||
"""
|
||||
context_parts = []
|
||||
|
||||
# 1. Read implement.jsonl
|
||||
base_context = get_agent_context(repo_root, task_dir, "implement")
|
||||
if base_context:
|
||||
context_parts.append(base_context)
|
||||
|
||||
# 2. Requirements document
|
||||
prd_content = read_file_content(repo_root, f"{task_dir}/prd.md")
|
||||
if prd_content:
|
||||
context_parts.append(f"=== {task_dir}/prd.md (Requirements) ===\n{prd_content}")
|
||||
|
||||
# 3. Technical design
|
||||
info_content = read_file_content(repo_root, f"{task_dir}/info.md")
|
||||
if info_content:
|
||||
context_parts.append(
|
||||
f"=== {task_dir}/info.md (Technical Design) ===\n{info_content}"
|
||||
)
|
||||
|
||||
return "\n\n".join(context_parts)
|
||||
|
||||
|
||||
def get_check_context(repo_root: str, task_dir: str) -> str:
|
||||
"""
|
||||
Context for Check Agent: check.jsonl + prd.md
|
||||
"""
|
||||
context_parts = []
|
||||
|
||||
for file_path, content in read_jsonl_entries(repo_root, f"{task_dir}/check.jsonl"):
|
||||
context_parts.append(f"=== {file_path} ===\n{content}")
|
||||
|
||||
prd_content = read_file_content(repo_root, f"{task_dir}/prd.md")
|
||||
if prd_content:
|
||||
context_parts.append(f"=== {task_dir}/prd.md (Requirements) ===\n{prd_content}")
|
||||
|
||||
return "\n\n".join(context_parts)
|
||||
|
||||
|
||||
def get_finish_context(repo_root: str, task_dir: str) -> str:
|
||||
"""
|
||||
Context for Finish phase: reuses check.jsonl + prd.md
|
||||
(Finish is a final check, same context source.)
|
||||
"""
|
||||
return get_check_context(repo_root, task_dir)
|
||||
|
||||
|
||||
|
||||
def build_implement_prompt(original_prompt: str, context: str) -> str:
|
||||
"""Build complete prompt for Implement"""
|
||||
return f"""# Implement Agent Task
|
||||
|
||||
You are the Implement Agent in the Multi-Agent Pipeline.
|
||||
|
||||
## Your Context
|
||||
|
||||
All the information you need has been prepared for you:
|
||||
|
||||
{context}
|
||||
|
||||
---
|
||||
|
||||
## Your Task
|
||||
|
||||
{original_prompt}
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Understand specs** - All dev specs are injected above, understand them
|
||||
2. **Understand requirements** - Read requirements document and technical design
|
||||
3. **Implement feature** - Implement following specs and design
|
||||
4. **Self-check** - Ensure code quality against check specs
|
||||
|
||||
## Important Constraints
|
||||
|
||||
- Do NOT execute git commit, only code modifications
|
||||
- Follow all dev specs injected above
|
||||
- Report list of modified/created files when done"""
|
||||
|
||||
|
||||
def build_check_prompt(original_prompt: str, context: str) -> str:
|
||||
"""Build complete prompt for Check"""
|
||||
return f"""# Check Agent Task
|
||||
|
||||
You are the Check Agent in the Multi-Agent Pipeline (code and cross-layer checker).
|
||||
|
||||
## Your Context
|
||||
|
||||
All check specs and dev specs you need:
|
||||
|
||||
{context}
|
||||
|
||||
---
|
||||
|
||||
## Your Task
|
||||
|
||||
{original_prompt}
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Get changes** - Run `git diff --name-only` and `git diff` to get code changes
|
||||
2. **Check against specs** - Check item by item against specs above
|
||||
3. **Self-fix** - Fix issues directly, don't just report
|
||||
4. **Run verification** - Run project's lint and typecheck commands
|
||||
|
||||
## Important Constraints
|
||||
|
||||
- Fix issues yourself, don't just report
|
||||
- Must execute complete checklist in check specs
|
||||
- Pay special attention to impact radius analysis (L1-L5)"""
|
||||
|
||||
|
||||
def build_finish_prompt(original_prompt: str, context: str) -> str:
|
||||
"""Build complete prompt for Finish (final check before PR)"""
|
||||
return f"""# Finish Agent Task
|
||||
|
||||
You are performing the final check before creating a PR.
|
||||
|
||||
## Your Context
|
||||
|
||||
Finish checklist and requirements:
|
||||
|
||||
{context}
|
||||
|
||||
---
|
||||
|
||||
## Your Task
|
||||
|
||||
{original_prompt}
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Review changes** - Run `git diff --name-only` to see all changed files
|
||||
2. **Verify requirements** - Check each requirement in prd.md is implemented
|
||||
3. **Spec sync** - Analyze whether changes introduce new patterns, contracts, or conventions
|
||||
- If new pattern/convention found: read target spec file → update it → update index.md if needed
|
||||
- If infra/cross-layer change: follow the 7-section mandatory template from update-spec.md
|
||||
- If pure code fix with no new patterns: skip this step
|
||||
4. **Run final checks** - Execute lint and typecheck
|
||||
5. **Confirm ready** - Ensure code is ready for PR
|
||||
|
||||
## Important Constraints
|
||||
|
||||
- You MAY update spec files when gaps are detected (use update-spec.md as guide)
|
||||
- MUST read the target spec file BEFORE editing (avoid duplicating existing content)
|
||||
- Do NOT update specs for trivial changes (typos, formatting, obvious fixes)
|
||||
- If critical CODE issues found, report them clearly (fix specs, not code)
|
||||
- Verify all acceptance criteria in prd.md are met"""
|
||||
|
||||
|
||||
|
||||
def get_research_context(repo_root: str, task_dir: str | None) -> str:
|
||||
"""
|
||||
Context for Research Agent — project structure overview for spec directories.
|
||||
|
||||
`task_dir` kept for signature parity with get_implement_context / get_check_context
|
||||
so the dispatcher can call them uniformly.
|
||||
"""
|
||||
_ = task_dir
|
||||
context_parts = []
|
||||
|
||||
# 1. Project structure overview (dynamically discover spec directories)
|
||||
spec_path = f"{DIR_WORKFLOW}/{DIR_SPEC}"
|
||||
spec_root = Path(repo_root) / DIR_WORKFLOW / DIR_SPEC
|
||||
|
||||
# Build spec tree dynamically
|
||||
tree_lines = [f"{spec_path}/"]
|
||||
if spec_root.is_dir():
|
||||
pkg_dirs = sorted(d for d in spec_root.iterdir() if d.is_dir())
|
||||
for i, pkg_dir in enumerate(pkg_dirs):
|
||||
is_last = i == len(pkg_dirs) - 1
|
||||
prefix = "└── " if is_last else "├── "
|
||||
layers = sorted(d.name for d in pkg_dir.iterdir() if d.is_dir())
|
||||
layer_info = f" ({', '.join(layers)})" if layers else ""
|
||||
tree_lines.append(f"{prefix}{pkg_dir.name}/{layer_info}")
|
||||
|
||||
spec_tree = "\n".join(tree_lines)
|
||||
|
||||
project_structure = f"""## Project Spec Directory Structure
|
||||
|
||||
```
|
||||
{spec_tree}
|
||||
```
|
||||
|
||||
To get structured package info, run: `python3 ./{DIR_WORKFLOW}/scripts/get_context.py --mode packages`
|
||||
|
||||
## Search Tips
|
||||
|
||||
- Spec files: `{spec_path}/**/*.md`
|
||||
- Code search: Use Glob and Grep tools
|
||||
- Tech solutions: Use mcp__exa__web_search_exa or mcp__exa__get_code_context_exa"""
|
||||
|
||||
context_parts.append(project_structure)
|
||||
|
||||
return "\n\n".join(context_parts)
|
||||
|
||||
|
||||
def build_research_prompt(original_prompt: str, context: str) -> str:
|
||||
"""Build complete prompt for Research"""
|
||||
return f"""# Research Agent Task
|
||||
|
||||
You are the Research Agent in the Multi-Agent Pipeline (search researcher).
|
||||
|
||||
## Core Principle
|
||||
|
||||
**You do one thing: find and explain information.**
|
||||
|
||||
You are a documenter, not a reviewer.
|
||||
|
||||
## Project Info
|
||||
|
||||
{context}
|
||||
|
||||
---
|
||||
|
||||
## Your Task
|
||||
|
||||
{original_prompt}
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Understand query** - Determine search type (internal/external) and scope
|
||||
2. **Plan search** - List search steps for complex queries
|
||||
3. **Execute search** - Execute multiple independent searches in parallel
|
||||
4. **Organize results** - Output structured report
|
||||
|
||||
## Search Tools
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| Glob | Search by filename pattern |
|
||||
| Grep | Search by content |
|
||||
| Read | Read file content |
|
||||
| mcp__exa__web_search_exa | External web search |
|
||||
| mcp__exa__get_code_context_exa | External code/doc search |
|
||||
|
||||
## Strict Boundaries
|
||||
|
||||
**Only allowed**: Describe what exists, where it is, how it works
|
||||
|
||||
**Forbidden** (unless explicitly asked):
|
||||
- Suggest improvements
|
||||
- Criticize implementation
|
||||
- Recommend refactoring
|
||||
- Modify any files
|
||||
|
||||
## Report Format
|
||||
|
||||
Provide structured search results including:
|
||||
- List of files found (with paths)
|
||||
- Code pattern analysis (if applicable)
|
||||
- Related spec documents
|
||||
- External references (if any)"""
|
||||
|
||||
|
||||
def _string_value(value: Any) -> str:
|
||||
if isinstance(value, str):
|
||||
stripped = value.strip()
|
||||
return stripped
|
||||
return ""
|
||||
|
||||
|
||||
def _extract_subagent_name(value: Any) -> str:
|
||||
"""Extract a sub-agent name from common platform encodings.
|
||||
|
||||
Cursor's native Task args encode custom sub-agents as a protobuf oneof,
|
||||
which can appear in hook JSON as either ``{"custom": {"name": "..."}}``
|
||||
or ``{"type": {"case": "custom", "value": {"name": "..."}}}``.
|
||||
"""
|
||||
direct = _string_value(value)
|
||||
if direct:
|
||||
return direct
|
||||
|
||||
if not isinstance(value, dict):
|
||||
return ""
|
||||
|
||||
for key in ("name", "subagent_type_name", "subagentTypeName"):
|
||||
direct = _string_value(value.get(key))
|
||||
if direct:
|
||||
return direct
|
||||
|
||||
custom = value.get("custom")
|
||||
if isinstance(custom, dict):
|
||||
custom_name = _string_value(custom.get("name"))
|
||||
if custom_name:
|
||||
return custom_name
|
||||
|
||||
oneof = value.get("type")
|
||||
if isinstance(oneof, dict):
|
||||
case_name = _string_value(oneof.get("case"))
|
||||
if case_name == "custom":
|
||||
nested_value = oneof.get("value")
|
||||
if isinstance(nested_value, dict):
|
||||
custom_name = _string_value(nested_value.get("name"))
|
||||
if custom_name:
|
||||
return custom_name
|
||||
if case_name:
|
||||
return case_name
|
||||
|
||||
case_name = _string_value(value.get("case"))
|
||||
if case_name == "custom":
|
||||
nested_value = value.get("value")
|
||||
if isinstance(nested_value, dict):
|
||||
custom_name = _string_value(nested_value.get("name"))
|
||||
if custom_name:
|
||||
return custom_name
|
||||
if case_name:
|
||||
return case_name
|
||||
|
||||
for agent_name in AGENTS_ALL:
|
||||
if agent_name in value:
|
||||
return agent_name
|
||||
|
||||
return ""
|
||||
|
||||
|
||||
def _extract_subagent_type(tool_input: dict) -> str:
|
||||
for key in (
|
||||
"subagent_type",
|
||||
"subagentType",
|
||||
"subagent_type_name",
|
||||
"subagentTypeName",
|
||||
"agent_type",
|
||||
"agentType",
|
||||
"name",
|
||||
):
|
||||
agent_name = _extract_subagent_name(tool_input.get(key))
|
||||
if agent_name:
|
||||
return agent_name
|
||||
return ""
|
||||
|
||||
|
||||
def _parse_hook_input(input_data: dict) -> tuple[str, str, dict]:
|
||||
"""Parse hook input across different platform formats.
|
||||
|
||||
Returns (subagent_type, original_prompt, tool_input).
|
||||
Handles:
|
||||
- Claude Code / Qoder / CodeBuddy / Droid: tool_name=Task|Agent, tool_input.subagent_type
|
||||
- Cursor: tool_name=Task|Subagent, tool_input.subagent_type
|
||||
- Copilot CLI: toolName=task (camelCase key, lowercase value)
|
||||
- Gemini CLI: tool_name IS the agent name (BeforeTool matcher already filtered)
|
||||
- Kiro: agentSpawn hook, agent_name field at top level
|
||||
"""
|
||||
tool_input = input_data.get("tool_input", {})
|
||||
|
||||
# Standard format: Task/Agent tool with subagent_type
|
||||
tool_name = input_data.get("tool_name", "") or input_data.get("toolName", "")
|
||||
if tool_name.lower() in ("task", "agent", "subagent"):
|
||||
return (
|
||||
_extract_subagent_type(tool_input),
|
||||
tool_input.get("prompt", ""),
|
||||
tool_input,
|
||||
)
|
||||
|
||||
# Kiro: agentSpawn hook passes agent_name at top level
|
||||
agent_name = input_data.get("agent_name", "")
|
||||
if agent_name:
|
||||
return agent_name, tool_input.get("prompt", input_data.get("prompt", "")), tool_input
|
||||
|
||||
# Gemini CLI: BeforeTool where tool_name IS the agent name
|
||||
# (matcher already ensured it's one of our agents)
|
||||
if tool_name in AGENTS_ALL:
|
||||
return tool_name, tool_input.get("prompt", ""), tool_input
|
||||
|
||||
# Copilot CLI: toolName field (camelCase), value might be the agent name
|
||||
tool_name_camel = input_data.get("toolName", "")
|
||||
if tool_name_camel in AGENTS_ALL:
|
||||
return tool_name_camel, input_data.get("toolArgs", ""), tool_input
|
||||
|
||||
return "", "", tool_input
|
||||
|
||||
|
||||
def main():
|
||||
if os.environ.get("TRELLIS_HOOKS") == "0" or os.environ.get("TRELLIS_DISABLE_HOOKS") == "1":
|
||||
sys.exit(0)
|
||||
|
||||
try:
|
||||
input_data = json.load(sys.stdin)
|
||||
except json.JSONDecodeError:
|
||||
sys.exit(0)
|
||||
|
||||
subagent_type, original_prompt, tool_input = _parse_hook_input(input_data)
|
||||
cwd = input_data.get("cwd", os.getcwd())
|
||||
|
||||
# Only handle subagent types we care about
|
||||
if subagent_type not in AGENTS_ALL:
|
||||
sys.exit(0)
|
||||
|
||||
# Find repo root
|
||||
repo_root = find_repo_root(cwd)
|
||||
if not repo_root:
|
||||
sys.exit(0)
|
||||
|
||||
# Get current task directory (research doesn't require it)
|
||||
task_dir = get_current_task(repo_root, input_data)
|
||||
|
||||
# implement/check need task directory
|
||||
if subagent_type in AGENTS_REQUIRE_TASK:
|
||||
if not task_dir:
|
||||
sys.exit(0)
|
||||
# Check if task directory exists
|
||||
task_dir_full = os.path.join(repo_root, task_dir)
|
||||
if not os.path.exists(task_dir_full):
|
||||
sys.exit(0)
|
||||
|
||||
# Check for [finish] marker in prompt (check agent with finish context)
|
||||
is_finish_phase = "[finish]" in original_prompt.lower()
|
||||
|
||||
# Get context and build prompt based on subagent type
|
||||
if subagent_type == AGENT_IMPLEMENT:
|
||||
assert task_dir is not None # validated above
|
||||
context = get_implement_context(repo_root, task_dir)
|
||||
new_prompt = build_implement_prompt(original_prompt, context)
|
||||
elif subagent_type == AGENT_CHECK:
|
||||
assert task_dir is not None # validated above
|
||||
if is_finish_phase:
|
||||
# Finish phase: use finish context (lighter, focused on final verification)
|
||||
context = get_finish_context(repo_root, task_dir)
|
||||
new_prompt = build_finish_prompt(original_prompt, context)
|
||||
else:
|
||||
# Regular check phase: use check context (full specs for self-fix loop)
|
||||
context = get_check_context(repo_root, task_dir)
|
||||
new_prompt = build_check_prompt(original_prompt, context)
|
||||
elif subagent_type == AGENT_RESEARCH:
|
||||
# Research can work without task directory
|
||||
context = get_research_context(repo_root, task_dir)
|
||||
new_prompt = build_research_prompt(original_prompt, context)
|
||||
else:
|
||||
sys.exit(0)
|
||||
|
||||
if not context:
|
||||
sys.exit(0)
|
||||
|
||||
# Return updated input — use a multi-format output that covers all platforms.
|
||||
# Most platforms ignore unrecognized fields, so we include multiple formats.
|
||||
# The platform picks whichever fields it understands.
|
||||
updated = {**tool_input, "prompt": new_prompt}
|
||||
output = {
|
||||
# Claude Code / Qoder / CodeBuddy / Droid format
|
||||
"hookSpecificOutput": {
|
||||
"hookEventName": "PreToolUse",
|
||||
"permissionDecision": "allow",
|
||||
"updatedInput": updated,
|
||||
},
|
||||
# Cursor format
|
||||
"permission": "allow",
|
||||
"updated_input": updated,
|
||||
# Gemini format
|
||||
"updatedInput": updated,
|
||||
}
|
||||
|
||||
print(json.dumps(output, ensure_ascii=False))
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Executable
+240
@@ -0,0 +1,240 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Trellis per-turn breadcrumb hook (UserPromptSubmit / BeforeAgent equivalent).
|
||||
|
||||
Runs on every user prompt. Resolves the active task through Trellis'
|
||||
session-aware active task resolver and emits a short <workflow-state>
|
||||
block reminding the main AI what task is active and its expected flow.
|
||||
|
||||
The emitted ``hookEventName`` field is platform-aware: most hosts expect
|
||||
``UserPromptSubmit`` (Claude Code naming, also accepted by Cursor / Qoder /
|
||||
CodeBuddy / Droid / Codex / Copilot wiring), but Gemini CLI 0.40.x renamed
|
||||
its per-turn event to ``BeforeAgent`` and its schema validator rejects the
|
||||
legacy name. ``_detect_platform`` picks the right value at runtime.
|
||||
Breadcrumb text is pulled exclusively from workflow.md
|
||||
[workflow-state:STATUS] tag blocks — workflow.md is the single source of
|
||||
truth. There are no fallback dicts in this script: when workflow.md is
|
||||
missing or a tag is absent, the breadcrumb degrades to a generic
|
||||
"Refer to workflow.md for current step." line so users see (and fix)
|
||||
the broken state instead of the hook silently masking it.
|
||||
|
||||
Shared across all hook-capable platforms (Claude, Cursor, Codex, Qoder,
|
||||
CodeBuddy, Droid, Gemini, Copilot). Kiro is not wired (no per-turn
|
||||
hook entry point). Written to each platform's hooks directory via
|
||||
writeSharedHooks() at init time.
|
||||
|
||||
Silent exit 0 cases (no output):
|
||||
- No .trellis/ directory found (not a Trellis project)
|
||||
- task.json malformed or missing status
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# CWD-robust Trellis root discovery (fixes hook-path-robustness for this hook)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def find_trellis_root(start: Path) -> Optional[Path]:
|
||||
"""Walk up from start to find directory containing .trellis/.
|
||||
|
||||
Handles CWD drift: subdirectory launches, monorepo packages, etc.
|
||||
Returns None if no .trellis/ found (silent no-op).
|
||||
"""
|
||||
cur = start.resolve()
|
||||
while cur != cur.parent:
|
||||
if (cur / ".trellis").is_dir():
|
||||
return cur
|
||||
cur = cur.parent
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Active task discovery
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _detect_platform(input_data: dict) -> str | None:
|
||||
if isinstance(input_data.get("cursor_version"), str):
|
||||
return "cursor"
|
||||
env_map = {
|
||||
"CLAUDE_PROJECT_DIR": "claude",
|
||||
"CURSOR_PROJECT_DIR": "cursor",
|
||||
"CODEBUDDY_PROJECT_DIR": "codebuddy",
|
||||
"FACTORY_PROJECT_DIR": "droid",
|
||||
"GEMINI_PROJECT_DIR": "gemini",
|
||||
"QODER_PROJECT_DIR": "qoder",
|
||||
"KIRO_PROJECT_DIR": "kiro",
|
||||
"COPILOT_PROJECT_DIR": "copilot",
|
||||
}
|
||||
for env_name, platform in env_map.items():
|
||||
if os.environ.get(env_name):
|
||||
return platform
|
||||
script_parts = set(Path(sys.argv[0]).parts)
|
||||
if ".claude" in script_parts:
|
||||
return "claude"
|
||||
if ".cursor" in script_parts:
|
||||
return "cursor"
|
||||
if ".codex" in script_parts:
|
||||
return "codex"
|
||||
if ".gemini" in script_parts:
|
||||
return "gemini"
|
||||
if ".qoder" in script_parts:
|
||||
return "qoder"
|
||||
if ".codebuddy" in script_parts:
|
||||
return "codebuddy"
|
||||
if ".factory" in script_parts:
|
||||
return "droid"
|
||||
if ".kiro" in script_parts:
|
||||
return "kiro"
|
||||
return None
|
||||
|
||||
|
||||
def _resolve_active_task(root: Path, input_data: dict):
|
||||
scripts_dir = root / ".trellis" / "scripts"
|
||||
if str(scripts_dir) not in sys.path:
|
||||
sys.path.insert(0, str(scripts_dir))
|
||||
from common.active_task import resolve_active_task # type: ignore[import-not-found]
|
||||
|
||||
return resolve_active_task(root, input_data, platform=_detect_platform(input_data))
|
||||
|
||||
|
||||
def get_active_task(root: Path, input_data: dict) -> Optional[tuple[str, str, str]]:
|
||||
"""Return (task_id, status, source) from the current active task."""
|
||||
active = _resolve_active_task(root, input_data)
|
||||
if not active.task_path:
|
||||
return None
|
||||
|
||||
task_dir = Path(active.task_path)
|
||||
if not task_dir.is_absolute():
|
||||
task_dir = root / task_dir
|
||||
if active.stale:
|
||||
return task_dir.name, f"stale_{active.source_type}", active.source
|
||||
|
||||
task_json = task_dir / "task.json"
|
||||
if not task_json.is_file():
|
||||
return None
|
||||
try:
|
||||
data = json.loads(task_json.read_text(encoding="utf-8"))
|
||||
except (json.JSONDecodeError, OSError):
|
||||
return None
|
||||
|
||||
task_id = data.get("id") or task_dir.name
|
||||
status = data.get("status", "")
|
||||
if not isinstance(status, str) or not status:
|
||||
return None
|
||||
return task_id, status, active.source
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Breadcrumb loading: parse workflow.md, fall back to hardcoded defaults
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# Supports STATUS values with letters, digits, underscores, hyphens
|
||||
# (so "in-review" / "blocked-by-team" work alongside "in_progress").
|
||||
_TAG_RE = re.compile(
|
||||
r"\[workflow-state:([A-Za-z0-9_-]+)\]\s*\n(.*?)\n\s*\[/workflow-state:\1\]",
|
||||
re.DOTALL,
|
||||
)
|
||||
|
||||
def load_breadcrumbs(root: Path) -> dict[str, str]:
|
||||
"""Parse workflow.md for [workflow-state:STATUS] blocks.
|
||||
|
||||
Returns {status: body_text}. workflow.md is the single source of
|
||||
truth — there are no fallback dicts in this script. Missing tags
|
||||
(or a missing/unreadable workflow.md) fall back to a generic line
|
||||
in build_breadcrumb so users see the broken state and fix
|
||||
workflow.md, rather than the hook silently masking the issue.
|
||||
"""
|
||||
workflow = root / ".trellis" / "workflow.md"
|
||||
if not workflow.is_file():
|
||||
return {}
|
||||
try:
|
||||
content = workflow.read_text(encoding="utf-8")
|
||||
except OSError:
|
||||
return {}
|
||||
|
||||
result: dict[str, str] = {}
|
||||
for match in _TAG_RE.finditer(content):
|
||||
status = match.group(1)
|
||||
body = match.group(2).strip()
|
||||
if body:
|
||||
result[status] = body
|
||||
return result
|
||||
|
||||
|
||||
def build_breadcrumb(
|
||||
task_id: Optional[str],
|
||||
status: str,
|
||||
templates: dict[str, str],
|
||||
source: str | None = None,
|
||||
) -> str:
|
||||
"""Build the <workflow-state>...</workflow-state> block.
|
||||
|
||||
- Known status (tag present in workflow.md) → detailed template body
|
||||
- Unknown status (no tag, or workflow.md missing) → generic
|
||||
"Refer to workflow.md for current step." line
|
||||
- `no_task` pseudo-status (task_id is None) → header omits task info
|
||||
"""
|
||||
body = templates.get(status)
|
||||
if body is None:
|
||||
body = "Refer to workflow.md for current step."
|
||||
header = f"Status: {status}" if task_id is None else f"Task: {task_id} ({status})"
|
||||
if source:
|
||||
header = f"{header}\nSource: {source}"
|
||||
return f"<workflow-state>\n{header}\n{body}\n</workflow-state>"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Entry
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def main() -> int:
|
||||
if os.environ.get("TRELLIS_HOOKS") == "0" or os.environ.get("TRELLIS_DISABLE_HOOKS") == "1":
|
||||
return 0
|
||||
|
||||
try:
|
||||
data = json.load(sys.stdin)
|
||||
except (json.JSONDecodeError, ValueError):
|
||||
data = {}
|
||||
|
||||
cwd_str = data.get("cwd") or os.getcwd()
|
||||
cwd = Path(cwd_str)
|
||||
|
||||
root = find_trellis_root(cwd)
|
||||
if root is None:
|
||||
return 0 # not a Trellis project
|
||||
|
||||
templates = load_breadcrumbs(root)
|
||||
task = get_active_task(root, data)
|
||||
if task is None:
|
||||
# No active task — still emit a breadcrumb nudging AI toward
|
||||
# trellis-brainstorm + task.py create when user describes real work.
|
||||
breadcrumb = build_breadcrumb(None, "no_task", templates)
|
||||
else:
|
||||
task_id, status, source = task
|
||||
breadcrumb = build_breadcrumb(task_id, status, templates, source)
|
||||
|
||||
# Gemini CLI 0.40.x rejects "UserPromptSubmit" — its per-turn event is
|
||||
# named "BeforeAgent". Other platforms (Claude/Cursor/Qoder/CodeBuddy/
|
||||
# Droid/Codex/Copilot) accept the original Claude-style name.
|
||||
hook_event_name = (
|
||||
"BeforeAgent" if _detect_platform(data) == "gemini" else "UserPromptSubmit"
|
||||
)
|
||||
|
||||
output = {
|
||||
"hookSpecificOutput": {
|
||||
"hookEventName": hook_event_name,
|
||||
"additionalContext": breadcrumb,
|
||||
}
|
||||
}
|
||||
print(json.dumps(output))
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Executable
+769
@@ -0,0 +1,769 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Session Start Hook - Inject structured context
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
# IMPORTANT: Suppress all warnings FIRST
|
||||
import warnings
|
||||
warnings.filterwarnings("ignore")
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import shlex
|
||||
import subprocess
|
||||
import sys
|
||||
from io import StringIO
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def _normalize_windows_shell_path(path_str: str) -> str:
|
||||
"""Normalize Unix-style shell paths to real Windows paths.
|
||||
|
||||
On Windows, shells like Git Bash / MSYS2 / Cygwin may report paths like
|
||||
`/d/Users/...` or `/cygdrive/d/Users/...`. `Path.resolve()` will misinterpret
|
||||
these as `D:/d/Users...` on drive D: (or similar), breaking repo root
|
||||
detection.
|
||||
|
||||
This function is intentionally conservative: it only rewrites patterns that
|
||||
unambiguously represent a drive letter mount.
|
||||
"""
|
||||
if not isinstance(path_str, str) or not path_str:
|
||||
return path_str
|
||||
|
||||
# Only relevant on Windows; keep other platforms untouched.
|
||||
if not sys.platform.startswith("win"):
|
||||
return path_str
|
||||
|
||||
p = path_str.strip()
|
||||
|
||||
# Already a Windows drive path (C:\... or C:/...)
|
||||
if re.match(r"^[A-Za-z]:[\/]", p):
|
||||
return p
|
||||
|
||||
# MSYS/Git-Bash style: /c/Users/... or /d/Work/...
|
||||
m = re.match(r"^/([A-Za-z])/(.*)", p)
|
||||
if m:
|
||||
drive, rest = m.group(1).upper(), m.group(2)
|
||||
return f"{drive}:\\{rest.replace('/', '\\')}"
|
||||
|
||||
# Cygwin style: /cygdrive/c/Users/...
|
||||
m = re.match(r"^/cygdrive/([A-Za-z])/(.*)", p)
|
||||
if m:
|
||||
drive, rest = m.group(1).upper(), m.group(2)
|
||||
return f"{drive}:\\{rest.replace('/', '\\')}"
|
||||
|
||||
# WSL mounted drive (sometimes leaked into env): /mnt/c/Users/...
|
||||
m = re.match(r"^/mnt/([A-Za-z])/(.*)", p)
|
||||
if m:
|
||||
drive, rest = m.group(1).upper(), m.group(2)
|
||||
return f"{drive}:\\{rest.replace('/', '\\')}"
|
||||
|
||||
return path_str
|
||||
|
||||
|
||||
FIRST_REPLY_NOTICE = """<first-reply-notice>
|
||||
On the first visible assistant reply in this session, begin with exactly one short Chinese sentence:
|
||||
Trellis SessionStart 已注入：workflow、当前任务状态、开发者身份、git 状态、active tasks、spec 索引已加载。
|
||||
Then continue directly with the user's request. This notice is one-shot: do not repeat it after the first assistant reply in the same session.
|
||||
</first-reply-notice>"""
|
||||
|
||||
# IMPORTANT: Force stdout to use UTF-8 on Windows
|
||||
# This fixes UnicodeEncodeError when outputting non-ASCII characters
|
||||
if sys.platform.startswith("win"):
|
||||
import io as _io
|
||||
if hasattr(sys.stdout, "reconfigure"):
|
||||
sys.stdout.reconfigure(encoding="utf-8", errors="replace") # type: ignore[union-attr]
|
||||
elif hasattr(sys.stdout, "detach"):
|
||||
sys.stdout = _io.TextIOWrapper(sys.stdout.detach(), encoding="utf-8", errors="replace") # type: ignore[union-attr]
|
||||
|
||||
|
||||
|
||||
def _has_curated_jsonl_entry(jsonl_path: Path) -> bool:
|
||||
"""Return True iff jsonl has at least one row with a ``file`` field.
|
||||
|
||||
A freshly seeded jsonl only contains a ``{"_example": ...}`` row (no
|
||||
``file`` key) — that is NOT "ready". Readiness requires at least one
|
||||
curated entry. Matches the contract used by hook-inject and pull-based
|
||||
sub-agent context loaders.
|
||||
"""
|
||||
try:
|
||||
for line in jsonl_path.read_text(encoding="utf-8").splitlines():
|
||||
line = line.strip()
|
||||
if not line:
|
||||
continue
|
||||
try:
|
||||
row = json.loads(line)
|
||||
except json.JSONDecodeError:
|
||||
continue
|
||||
if isinstance(row, dict) and row.get("file"):
|
||||
return True
|
||||
except (OSError, UnicodeDecodeError):
|
||||
return False
|
||||
return False
|
||||
|
||||
|
||||
def should_skip_injection() -> bool:
|
||||
"""Check if any platform's non-interactive flag is set, or if Trellis
|
||||
hooks are explicitly disabled via TRELLIS_HOOKS=0 / TRELLIS_DISABLE_HOOKS=1.
|
||||
"""
|
||||
if os.environ.get("TRELLIS_HOOKS") == "0":
|
||||
return True
|
||||
if os.environ.get("TRELLIS_DISABLE_HOOKS") == "1":
|
||||
return True
|
||||
non_interactive_vars = [
|
||||
"CLAUDE_NON_INTERACTIVE",
|
||||
"QODER_NON_INTERACTIVE",
|
||||
"CODEBUDDY_NON_INTERACTIVE",
|
||||
"FACTORY_NON_INTERACTIVE",
|
||||
"CURSOR_NON_INTERACTIVE",
|
||||
"GEMINI_NON_INTERACTIVE",
|
||||
"KIRO_NON_INTERACTIVE",
|
||||
"COPILOT_NON_INTERACTIVE",
|
||||
]
|
||||
return any(os.environ.get(var) == "1" for var in non_interactive_vars)
|
||||
|
||||
|
||||
def read_file(path: Path, fallback: str = "") -> str:
|
||||
try:
|
||||
return path.read_text(encoding="utf-8")
|
||||
except (FileNotFoundError, PermissionError):
|
||||
return fallback
|
||||
|
||||
|
||||
def _detect_platform(input_data: dict) -> str | None:
|
||||
if isinstance(input_data.get("cursor_version"), str):
|
||||
return "cursor"
|
||||
env_map = {
|
||||
"CLAUDE_PROJECT_DIR": "claude",
|
||||
"CURSOR_PROJECT_DIR": "cursor",
|
||||
"CODEBUDDY_PROJECT_DIR": "codebuddy",
|
||||
"FACTORY_PROJECT_DIR": "droid",
|
||||
"GEMINI_PROJECT_DIR": "gemini",
|
||||
"QODER_PROJECT_DIR": "qoder",
|
||||
"KIRO_PROJECT_DIR": "kiro",
|
||||
"COPILOT_PROJECT_DIR": "copilot",
|
||||
}
|
||||
for env_name, platform in env_map.items():
|
||||
if os.environ.get(env_name):
|
||||
return platform
|
||||
script_parts = set(Path(sys.argv[0]).parts)
|
||||
if ".claude" in script_parts:
|
||||
return "claude"
|
||||
if ".cursor" in script_parts:
|
||||
return "cursor"
|
||||
if ".codex" in script_parts:
|
||||
return "codex"
|
||||
if ".gemini" in script_parts:
|
||||
return "gemini"
|
||||
if ".qoder" in script_parts:
|
||||
return "qoder"
|
||||
if ".codebuddy" in script_parts:
|
||||
return "codebuddy"
|
||||
if ".factory" in script_parts:
|
||||
return "droid"
|
||||
if ".kiro" in script_parts:
|
||||
return "kiro"
|
||||
return None
|
||||
|
||||
|
||||
def _resolve_context_key(trellis_dir: Path, input_data: dict) -> str | None:
|
||||
scripts_dir = trellis_dir / "scripts"
|
||||
if str(scripts_dir) not in sys.path:
|
||||
sys.path.insert(0, str(scripts_dir))
|
||||
from common.active_task import resolve_context_key # type: ignore[import-not-found]
|
||||
|
||||
return resolve_context_key(input_data, platform=_detect_platform(input_data))
|
||||
|
||||
|
||||
def _persist_context_key_for_bash(context_key: str | None) -> None:
|
||||
"""Expose Trellis session identity to later Claude Code Bash commands.
|
||||
|
||||
Claude Code SessionStart hooks can append exports to CLAUDE_ENV_FILE; those
|
||||
variables are then available to Bash tools in the same conversation. Without
|
||||
this bridge, `task.py start` has hook stdin during SessionStart but no
|
||||
session identity when the AI later runs it as a normal shell command.
|
||||
"""
|
||||
if not context_key:
|
||||
return
|
||||
env_file = os.environ.get("CLAUDE_ENV_FILE")
|
||||
if not env_file:
|
||||
return
|
||||
try:
|
||||
with open(env_file, "a", encoding="utf-8") as handle:
|
||||
handle.write(f"export TRELLIS_CONTEXT_ID={shlex.quote(context_key)}\n")
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def _resolve_active_task(trellis_dir: Path, input_data: dict):
|
||||
scripts_dir = trellis_dir / "scripts"
|
||||
if str(scripts_dir) not in sys.path:
|
||||
sys.path.insert(0, str(scripts_dir))
|
||||
from common.active_task import resolve_active_task # type: ignore[import-not-found]
|
||||
|
||||
return resolve_active_task(
|
||||
trellis_dir.parent,
|
||||
input_data,
|
||||
platform=_detect_platform(input_data),
|
||||
)
|
||||
|
||||
|
||||
def run_script(script_path: Path, context_key: str | None = None) -> str:
|
||||
try:
|
||||
if script_path.suffix == ".py":
|
||||
# Add PYTHONIOENCODING to force UTF-8 in subprocess
|
||||
env = os.environ.copy()
|
||||
env["PYTHONIOENCODING"] = "utf-8"
|
||||
if context_key:
|
||||
env["TRELLIS_CONTEXT_ID"] = context_key
|
||||
cmd = [sys.executable, "-W", "ignore", str(script_path)]
|
||||
else:
|
||||
env = os.environ.copy()
|
||||
if context_key:
|
||||
env["TRELLIS_CONTEXT_ID"] = context_key
|
||||
cmd = [str(script_path)]
|
||||
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
encoding="utf-8",
|
||||
errors="replace",
|
||||
timeout=5,
|
||||
cwd=script_path.parent.parent.parent,
|
||||
env=env,
|
||||
)
|
||||
return result.stdout if result.returncode == 0 else "No context available"
|
||||
except (subprocess.TimeoutExpired, FileNotFoundError, PermissionError):
|
||||
return "No context available"
|
||||
|
||||
|
||||
def _normalize_task_ref(task_ref: str) -> str:
|
||||
normalized = task_ref.strip()
|
||||
if not normalized:
|
||||
return ""
|
||||
|
||||
path_obj = Path(normalized)
|
||||
if path_obj.is_absolute():
|
||||
return str(path_obj)
|
||||
|
||||
normalized = normalized.replace("\\", "/")
|
||||
while normalized.startswith("./"):
|
||||
normalized = normalized[2:]
|
||||
|
||||
if normalized.startswith("tasks/"):
|
||||
return f".trellis/{normalized}"
|
||||
|
||||
return normalized
|
||||
|
||||
|
||||
def _resolve_task_dir(trellis_dir: Path, task_ref: str) -> Path:
|
||||
normalized = _normalize_task_ref(task_ref)
|
||||
path_obj = Path(normalized)
|
||||
if path_obj.is_absolute():
|
||||
return path_obj
|
||||
if normalized.startswith(".trellis/"):
|
||||
return trellis_dir.parent / path_obj
|
||||
return trellis_dir / "tasks" / path_obj
|
||||
|
||||
|
||||
def _get_task_status(trellis_dir: Path, input_data: dict) -> str:
|
||||
"""Check current task status and return structured status string with explicit next action.
|
||||
|
||||
Returns a block with three fields:
|
||||
- Status: current state
|
||||
- Task: task identifier (when applicable)
|
||||
- Next-Action: explicit skill/command/tool call the AI should invoke
|
||||
"""
|
||||
active = _resolve_active_task(trellis_dir, input_data)
|
||||
|
||||
# Case 1: No active task — waiting for user to describe intent
|
||||
if not active.task_path:
|
||||
return (
|
||||
"Status: NO ACTIVE TASK\n"
|
||||
f"Source: {active.source}\n"
|
||||
"Next-Action: After the user describes their intent, load skill `trellis-brainstorm` "
|
||||
"to clarify requirements and create a task via `python3 ./.trellis/scripts/task.py create`.\n"
|
||||
"Research reminder: for research-heavy tasks (comparing tools, reading external docs, "
|
||||
"cross-platform surveys), spawn `trellis-research` sub-agents via the Task tool — "
|
||||
"they persist findings to `{TASK_DIR}/research/*.md` and keep main context clean. "
|
||||
"Do NOT do 10+ inline WebFetch/WebSearch in the main conversation.\n"
|
||||
"User override (per-turn escape hatch): if the user's first message explicitly opts "
|
||||
"out of the workflow (\"跳过 trellis\" / \"别走流程\" / \"小修一下\" / \"直接改\" / "
|
||||
"\"skip trellis\" / \"no task\" / \"just do it\"), honor it for this turn — "
|
||||
"acknowledge briefly and proceed without creating a task. Per-turn only."
|
||||
)
|
||||
|
||||
# Case 2: Stale pointer — task dir was deleted
|
||||
task_ref = active.task_path
|
||||
task_dir = _resolve_task_dir(trellis_dir, task_ref)
|
||||
if active.stale or not task_dir.is_dir():
|
||||
return (
|
||||
f"Status: STALE POINTER\nTask: {task_ref}\n"
|
||||
f"Source: {active.source}\n"
|
||||
f"Next-Action: Run `python3 ./.trellis/scripts/task.py finish` to clear the stale pointer, "
|
||||
"then ask the user what to work on next."
|
||||
)
|
||||
|
||||
# Read task.json
|
||||
task_json_path = task_dir / "task.json"
|
||||
task_data = {}
|
||||
if task_json_path.is_file():
|
||||
try:
|
||||
task_data = json.loads(task_json_path.read_text(encoding="utf-8"))
|
||||
except (json.JSONDecodeError, PermissionError):
|
||||
pass
|
||||
|
||||
task_title = task_data.get("title", task_ref)
|
||||
task_status = task_data.get("status", "unknown")
|
||||
|
||||
# Case 3: Task completed — time to archive
|
||||
if task_status == "completed":
|
||||
return (
|
||||
f"Status: COMPLETED\nTask: {task_title}\n"
|
||||
f"Source: {active.source}\n"
|
||||
f"Next-Action: Load skill `trellis-update-spec` to capture learnings, "
|
||||
f"then archive with `python3 ./.trellis/scripts/task.py archive {task_dir.name}`."
|
||||
)
|
||||
|
||||
has_prd = (task_dir / "prd.md").is_file()
|
||||
|
||||
# Case 4: No PRD — still in Plan phase
|
||||
if not has_prd:
|
||||
return (
|
||||
f"Status: PLANNING\nTask: {task_title}\n"
|
||||
f"Source: {active.source}\n"
|
||||
"Next-Action: Load skill `trellis-brainstorm` to clarify requirements with the user "
|
||||
"and produce prd.md in the task directory.\n"
|
||||
"Research reminder: when the task needs external research (tool comparison, docs, "
|
||||
"conventions survey), spawn `trellis-research` sub-agents — don't WebFetch/WebSearch "
|
||||
"inline in the main session. Findings go to `{task_dir}/research/*.md`; PRD only links to them."
|
||||
)
|
||||
|
||||
# Case 4b: PRD exists but implement.jsonl has only seed (no curated entries) — Phase 1.3 gate
|
||||
implement_jsonl = task_dir / "implement.jsonl"
|
||||
if implement_jsonl.is_file() and not _has_curated_jsonl_entry(implement_jsonl):
|
||||
return (
|
||||
f"Status: PLANNING (Phase 1.3)\nTask: {task_title}\n"
|
||||
f"Source: {active.source}\n"
|
||||
"Next-Action: Curate `implement.jsonl` and `check.jsonl` with the spec + research files "
|
||||
"the Phase 2 sub-agents will need. Only spec paths (`.trellis/spec/**/*.md`) and research "
|
||||
"files (`{TASK_DIR}/research/*.md`) — no code paths. Run "
|
||||
"`python3 ./.trellis/scripts/get_context.py --mode packages` to list available specs, "
|
||||
"then edit the jsonl files or use `python3 ./.trellis/scripts/task.py add-context`. "
|
||||
"See `.trellis/workflow.md` Phase 1.3 for details."
|
||||
)
|
||||
|
||||
# Case 5: PRD + curated jsonl (or agent-less platform with no jsonl) — enter Execute phase
|
||||
return (
|
||||
f"Status: READY\nTask: {task_title}\n"
|
||||
f"Source: {active.source}\n"
|
||||
"Next required action: dispatch `trellis-implement` per Phase 2.1. "
|
||||
"For agent-capable platforms, the default is to NOT edit code in the main session. "
|
||||
"After implementation, dispatch `trellis-check` per Phase 2.2 before reporting completion.\n"
|
||||
"Sub-agent roster: `trellis-implement` (writes code), `trellis-check` (verifies + self-fixes), "
|
||||
"`trellis-research` (persists findings to `research/*.md` — use when you'd otherwise do "
|
||||
"multiple WebFetch/WebSearch inline).\n"
|
||||
"User override (per-turn escape hatch): if the user's CURRENT message explicitly tells the "
|
||||
"main session to handle it directly (\"你直接改\" / \"别派 sub-agent\" / \"main session 写就行\" / "
|
||||
"\"do it inline\" / \"不用 sub-agent\"), honor it for this turn and edit code directly. "
|
||||
"Per-turn only; do NOT invent an override the user did not say."
|
||||
)
|
||||
|
||||
|
||||
def _load_trellis_config(trellis_dir: Path, input_data: dict) -> tuple:
|
||||
"""Load Trellis config for session-start decisions.
|
||||
|
||||
Returns:
|
||||
(is_mono, packages_dict, spec_scope, task_pkg, default_pkg)
|
||||
"""
|
||||
scripts_dir = trellis_dir / "scripts"
|
||||
if str(scripts_dir) not in sys.path:
|
||||
sys.path.insert(0, str(scripts_dir))
|
||||
|
||||
try:
|
||||
from common.config import get_default_package, get_packages, get_spec_scope, is_monorepo # type: ignore[import-not-found]
|
||||
from common.paths import get_current_task # type: ignore[import-not-found]
|
||||
|
||||
repo_root = trellis_dir.parent
|
||||
is_mono = is_monorepo(repo_root)
|
||||
packages = get_packages(repo_root) or {}
|
||||
scope = get_spec_scope(repo_root)
|
||||
|
||||
# Get active task's package
|
||||
task_pkg = None
|
||||
current = get_current_task(
|
||||
repo_root,
|
||||
input_data,
|
||||
platform=_detect_platform(input_data),
|
||||
)
|
||||
if current:
|
||||
task_json = repo_root / current / "task.json"
|
||||
if task_json.is_file():
|
||||
try:
|
||||
data = json.loads(task_json.read_text(encoding="utf-8"))
|
||||
if isinstance(data, dict):
|
||||
tp = data.get("package")
|
||||
if isinstance(tp, str) and tp:
|
||||
task_pkg = tp
|
||||
except (json.JSONDecodeError, OSError):
|
||||
pass
|
||||
|
||||
default_pkg = get_default_package(repo_root)
|
||||
return is_mono, packages, scope, task_pkg, default_pkg
|
||||
except Exception:
|
||||
return False, {}, None, None, None
|
||||
|
||||
|
||||
def _check_legacy_spec(trellis_dir: Path, is_mono: bool, packages: dict) -> str | None:
|
||||
"""Check for legacy spec directory structure in monorepo.
|
||||
|
||||
Returns warning message if legacy structure detected, None otherwise.
|
||||
"""
|
||||
if not is_mono or not packages:
|
||||
return None
|
||||
|
||||
spec_dir = trellis_dir / "spec"
|
||||
if not spec_dir.is_dir():
|
||||
return None
|
||||
|
||||
# Check for legacy flat spec dirs (spec/backend/, spec/frontend/ with index.md)
|
||||
has_legacy = False
|
||||
for legacy_name in ("backend", "frontend"):
|
||||
legacy_dir = spec_dir / legacy_name
|
||||
if legacy_dir.is_dir() and (legacy_dir / "index.md").is_file():
|
||||
has_legacy = True
|
||||
break
|
||||
|
||||
if not has_legacy:
|
||||
return None
|
||||
|
||||
# Check which packages are missing spec/<pkg>/ directory
|
||||
missing = [
|
||||
name for name in sorted(packages.keys())
|
||||
if not (spec_dir / name).is_dir()
|
||||
]
|
||||
|
||||
if not missing:
|
||||
return None # All packages have spec dirs
|
||||
|
||||
if len(missing) == len(packages):
|
||||
return (
|
||||
f"[!] Legacy spec structure detected: found `spec/backend/` or `spec/frontend/` "
|
||||
f"but no package-scoped `spec/<package>/` directories.\n"
|
||||
f"Monorepo packages: {', '.join(sorted(packages.keys()))}\n"
|
||||
f"Please reorganize: `spec/backend/` -> `spec/<package>/backend/`"
|
||||
)
|
||||
return (
|
||||
f"[!] Partial spec migration detected: packages {', '.join(missing)} "
|
||||
f"still missing `spec/<pkg>/` directory.\n"
|
||||
f"Please complete migration for all packages."
|
||||
)
|
||||
|
||||
|
||||
def _resolve_spec_scope(
|
||||
is_mono: bool,
|
||||
packages: dict,
|
||||
scope,
|
||||
task_pkg: str | None,
|
||||
default_pkg: str | None,
|
||||
) -> set | None:
|
||||
"""Resolve which packages should have their specs injected.
|
||||
|
||||
Returns:
|
||||
Set of package names to include, or None for full scan.
|
||||
"""
|
||||
if not is_mono or not packages:
|
||||
return None # Single-repo: full scan
|
||||
|
||||
if scope is None:
|
||||
return None # No scope configured: full scan
|
||||
|
||||
if isinstance(scope, str) and scope == "active_task":
|
||||
if task_pkg and task_pkg in packages:
|
||||
return {task_pkg}
|
||||
if default_pkg and default_pkg in packages:
|
||||
return {default_pkg}
|
||||
return None # Fallback to full scan
|
||||
|
||||
if isinstance(scope, list):
|
||||
valid = set()
|
||||
for entry in scope:
|
||||
if entry in packages:
|
||||
valid.add(entry)
|
||||
else:
|
||||
print(
|
||||
f"Warning: spec_scope contains unknown package: {entry}, ignoring",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
if valid:
|
||||
# Warn if active task is out of scope
|
||||
if task_pkg and task_pkg not in valid:
|
||||
print(
|
||||
f"Warning: active task package '{task_pkg}' is out of configured spec_scope",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return valid
|
||||
|
||||
# All entries invalid: fallback chain
|
||||
print(
|
||||
"Warning: all spec_scope entries invalid, falling back to task/default/full",
|
||||
file=sys.stderr,
|
||||
)
|
||||
if task_pkg and task_pkg in packages:
|
||||
return {task_pkg}
|
||||
if default_pkg and default_pkg in packages:
|
||||
return {default_pkg}
|
||||
return None # Full scan
|
||||
|
||||
return None # Unknown scope type: full scan
|
||||
|
||||
|
||||
def _extract_range(content: str, start_header: str, end_header: str) -> str:
|
||||
"""Extract lines starting at `## start_header` up to (but excluding) `## end_header`.
|
||||
|
||||
Both parameters are full header lines WITHOUT the `## ` prefix (e.g. "Phase Index").
|
||||
Returns empty string if start header is not found.
|
||||
End header missing → extracts to end of file.
|
||||
"""
|
||||
lines = content.splitlines()
|
||||
start: int | None = None
|
||||
end: int = len(lines)
|
||||
start_match = f"## {start_header}"
|
||||
end_match = f"## {end_header}"
|
||||
for i, line in enumerate(lines):
|
||||
stripped = line.strip()
|
||||
if start is None and stripped == start_match:
|
||||
start = i
|
||||
continue
|
||||
if start is not None and stripped == end_match:
|
||||
end = i
|
||||
break
|
||||
if start is None:
|
||||
return ""
|
||||
return "\n".join(lines[start:end]).rstrip()
|
||||
|
||||
|
||||
_BREADCRUMB_TAG_RE = re.compile(
|
||||
r"\[workflow-state:([A-Za-z0-9_-]+)\]\s*\n.*?\n\s*\[/workflow-state:\1\]",
|
||||
re.DOTALL,
|
||||
)
|
||||
|
||||
|
||||
def _strip_breadcrumb_tag_blocks(content: str) -> str:
|
||||
"""Remove `[workflow-state:STATUS]...[/workflow-state:STATUS]` blocks.
|
||||
|
||||
The tag blocks live inside `## Phase Index` (since v0.5.0-rc.0, when
|
||||
they were colocated with their phase summaries) and are consumed by the
|
||||
UserPromptSubmit hook (`inject-workflow-state.py`). The session-start
|
||||
payload already covers the full step bodies, so re-inlining the
|
||||
breadcrumbs here would just duplicate context.
|
||||
"""
|
||||
return _BREADCRUMB_TAG_RE.sub("", content)
|
||||
|
||||
|
||||
def _build_workflow_overview(workflow_path: Path) -> str:
|
||||
"""Inject the workflow guide for the session.
|
||||
|
||||
Contents:
|
||||
1. Section index (all `## ` headings — navigation)
|
||||
2. Phase Index section (rules, skill routing table, anti-rationalization table)
|
||||
3. Phase 1/2/3 step-level details (the actual how-to for each step)
|
||||
|
||||
The meta sections (Core Principles / Trellis System / Customizing
|
||||
Trellis) are NOT injected — Core Principles is short prose the AI can
|
||||
Read on demand; Trellis System lists reference commands duplicated in
|
||||
step bodies; Customizing Trellis is for forks. Workflow-state breadcrumb
|
||||
tag blocks (which now live inside Phase Index since v0.5.0-rc.0) are
|
||||
stripped from the extracted range — they're consumed by the
|
||||
UserPromptSubmit hook, not the session-start preamble.
|
||||
|
||||
Total budget: Phase Index ~2 KB + Phase 1/2/3 ~7 KB = ~9 KB.
|
||||
"""
|
||||
content = read_file(workflow_path)
|
||||
if not content:
|
||||
return "No workflow.md found"
|
||||
|
||||
out_lines = [
|
||||
"# Development Workflow — Section Index",
|
||||
"Full guide: .trellis/workflow.md (read on demand)",
|
||||
"",
|
||||
"## Table of Contents",
|
||||
]
|
||||
for line in content.splitlines():
|
||||
if line.startswith("## "):
|
||||
out_lines.append(line)
|
||||
out_lines += ["", "---", ""]
|
||||
|
||||
# Extract Phase Index through the end of Phase 3 (before "Customizing
|
||||
# Trellis" — the docs-for-forks footer added in v0.5.0-rc.0). Since
|
||||
# sections appear in order Phase Index → Phase 1 → Phase 2 → Phase 3 →
|
||||
# Customizing Trellis, a single range grab captures all four. The
|
||||
# breadcrumb tag blocks now embedded inside Phase Index are stripped so
|
||||
# they don't duplicate the per-turn UserPromptSubmit injection.
|
||||
phases = _extract_range(
|
||||
content, "Phase Index", "Customizing Trellis (for forks)"
|
||||
)
|
||||
if phases:
|
||||
out_lines.append(_strip_breadcrumb_tag_blocks(phases).rstrip())
|
||||
|
||||
return "\n".join(out_lines).rstrip()
|
||||
|
||||
|
||||
def main():
|
||||
if should_skip_injection():
|
||||
sys.exit(0)
|
||||
|
||||
try:
|
||||
hook_input = json.loads(sys.stdin.read())
|
||||
if not isinstance(hook_input, dict):
|
||||
hook_input = {}
|
||||
except (json.JSONDecodeError, ValueError):
|
||||
hook_input = {}
|
||||
|
||||
# Try platform-specific env vars, hook cwd, fallback to cwd
|
||||
project_dir_env_vars = [
|
||||
"CLAUDE_PROJECT_DIR",
|
||||
"QODER_PROJECT_DIR",
|
||||
"CODEBUDDY_PROJECT_DIR",
|
||||
"FACTORY_PROJECT_DIR",
|
||||
"CURSOR_PROJECT_DIR",
|
||||
"GEMINI_PROJECT_DIR",
|
||||
"KIRO_PROJECT_DIR",
|
||||
"COPILOT_PROJECT_DIR",
|
||||
]
|
||||
project_dir = None
|
||||
for var in project_dir_env_vars:
|
||||
val = os.environ.get(var)
|
||||
if val:
|
||||
project_dir = Path(_normalize_windows_shell_path(val)).resolve()
|
||||
break
|
||||
if project_dir is None:
|
||||
project_dir = Path(_normalize_windows_shell_path(hook_input.get("cwd", "."))).resolve()
|
||||
|
||||
trellis_dir = project_dir / ".trellis"
|
||||
context_key = _resolve_context_key(trellis_dir, hook_input)
|
||||
_persist_context_key_for_bash(context_key)
|
||||
|
||||
# Load config for scope filtering and legacy detection
|
||||
is_mono, packages, scope_config, task_pkg, default_pkg = _load_trellis_config(
|
||||
trellis_dir,
|
||||
hook_input,
|
||||
)
|
||||
allowed_pkgs = _resolve_spec_scope(is_mono, packages, scope_config, task_pkg, default_pkg)
|
||||
|
||||
output = StringIO()
|
||||
|
||||
output.write("""<session-context>
|
||||
You are starting a new session in a Trellis-managed project.
|
||||
Read and follow all instructions below carefully.
|
||||
</session-context>
|
||||
|
||||
""")
|
||||
output.write(FIRST_REPLY_NOTICE)
|
||||
output.write("\n\n")
|
||||
|
||||
# Legacy migration warning
|
||||
legacy_warning = _check_legacy_spec(trellis_dir, is_mono, packages)
|
||||
if legacy_warning:
|
||||
output.write(f"<migration-warning>\n{legacy_warning}\n</migration-warning>\n\n")
|
||||
|
||||
output.write("<current-state>\n")
|
||||
context_script = trellis_dir / "scripts" / "get_context.py"
|
||||
output.write(run_script(context_script, context_key))
|
||||
output.write("\n</current-state>\n\n")
|
||||
|
||||
output.write("<workflow>\n")
|
||||
output.write(_build_workflow_overview(trellis_dir / "workflow.md"))
|
||||
output.write("\n</workflow>\n\n")
|
||||
|
||||
output.write("<guidelines>\n")
|
||||
output.write(
|
||||
"Project spec indexes are listed by path below. Each index contains a "
|
||||
"**Pre-Development Checklist** listing the specific guideline files to "
|
||||
"read before coding.\n\n"
|
||||
"- If you're spawning an implement/check sub-agent, context is injected "
|
||||
"or loaded by the sub-agent via `{task}/implement.jsonl` / `check.jsonl`. "
|
||||
"You do NOT need to read these indexes yourself.\n"
|
||||
"- For agent-capable platforms, the default is to dispatch "
|
||||
"`trellis-implement` and `trellis-check` (so JSONL context is loaded by "
|
||||
"the sub-agents) rather than editing code in the main session. "
|
||||
"Honor a per-turn user override only if the user's current message "
|
||||
"explicitly opts out (see <task-status> below for override phrases).\n\n"
|
||||
)
|
||||
|
||||
# guides/ is cross-package thinking — always include inline (small, broadly useful)
|
||||
guides_index = trellis_dir / "spec" / "guides" / "index.md"
|
||||
if guides_index.is_file():
|
||||
output.write("## guides (inlined — cross-package thinking guides)\n")
|
||||
output.write(read_file(guides_index))
|
||||
output.write("\n\n")
|
||||
|
||||
# Other spec indexes — paths only (main agent reads on demand;
|
||||
# sub-agents get their specific specs via jsonl injection)
|
||||
paths: list[str] = []
|
||||
spec_dir = trellis_dir / "spec"
|
||||
if spec_dir.is_dir():
|
||||
for sub in sorted(spec_dir.iterdir()):
|
||||
if not sub.is_dir() or sub.name.startswith("."):
|
||||
continue
|
||||
if sub.name == "guides":
|
||||
continue # already inlined above
|
||||
|
||||
index_file = sub / "index.md"
|
||||
if index_file.is_file():
|
||||
# Flat spec dir (single-repo layer like spec/backend/)
|
||||
paths.append(f".trellis/spec/{sub.name}/index.md")
|
||||
else:
|
||||
# Nested package dirs (monorepo: spec/<pkg>/<layer>/index.md)
|
||||
# Apply scope filter
|
||||
if allowed_pkgs is not None and sub.name not in allowed_pkgs:
|
||||
continue
|
||||
for nested in sorted(sub.iterdir()):
|
||||
if not nested.is_dir():
|
||||
continue
|
||||
nested_index = nested / "index.md"
|
||||
if nested_index.is_file():
|
||||
paths.append(
|
||||
f".trellis/spec/{sub.name}/{nested.name}/index.md"
|
||||
)
|
||||
|
||||
if paths:
|
||||
output.write("## Available spec indexes (read on demand)\n")
|
||||
for p in paths:
|
||||
output.write(f"- {p}\n")
|
||||
output.write("\n")
|
||||
|
||||
output.write(
|
||||
"Discover more via: "
|
||||
"`python3 ./.trellis/scripts/get_context.py --mode packages`\n"
|
||||
)
|
||||
output.write("</guidelines>\n\n")
|
||||
|
||||
# Check task status and inject structured tag
|
||||
task_status = _get_task_status(trellis_dir, hook_input)
|
||||
output.write(f"<task-status>\n{task_status}\n</task-status>\n\n")
|
||||
|
||||
output.write("""<ready>
|
||||
Context loaded. Workflow index, project state, and guidelines are already injected above — do NOT re-read them.
|
||||
When the user sends the first message, follow <task-status> and the workflow guide.
|
||||
If a task is READY, execute its Next required action without asking whether to continue.
|
||||
</ready>""")
|
||||
|
||||
result = {
|
||||
"hookSpecificOutput": {
|
||||
"hookEventName": "SessionStart",
|
||||
"additionalContext": output.getvalue(),
|
||||
}
|
||||
}
|
||||
|
||||
# Output JSON - stdout is already configured for UTF-8
|
||||
print(json.dumps(result, ensure_ascii=False), flush=True)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,73 @@
|
||||
{
|
||||
"env": {
|
||||
"CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR": "1"
|
||||
},
|
||||
"hooks": {
|
||||
"SessionStart": [
|
||||
{
|
||||
"matcher": "startup",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/session-start.py",
|
||||
"timeout": 10
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": "clear",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/session-start.py",
|
||||
"timeout": 10
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": "compact",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/session-start.py",
|
||||
"timeout": 10
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"PreToolUse": [
|
||||
{
|
||||
"matcher": "Task",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/inject-subagent-context.py",
|
||||
"timeout": 30
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": "Agent",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/inject-subagent-context.py",
|
||||
"timeout": 30
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"UserPromptSubmit": [
|
||||
{
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "python3 .claude/hooks/inject-workflow-state.py",
|
||||
"timeout": 5
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"enabledPlugins": {}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: trellis-before-dev
|
||||
description: "Discovers and injects project-specific coding guidelines from .trellis/spec/ before implementation begins. Reads spec indexes, pre-development checklists, and shared thinking guides for the target package. Use when starting a new coding task, before writing any code, switching to a different package, or needing to refresh project conventions and standards."
|
||||
---
|
||||
|
||||
Read the relevant development guidelines before starting your task.
|
||||
|
||||
Execute these steps:
|
||||
|
||||
1. **Discover packages and their spec layers**:
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode packages
|
||||
```
|
||||
|
||||
2. **Identify which specs apply** to your task based on:
|
||||
- Which package you're modifying (e.g., `cli/`, `docs-site/`)
|
||||
- What type of work (backend, frontend, unit-test, docs, etc.)
|
||||
|
||||
3. **Read the spec index** for each relevant module:
|
||||
```bash
|
||||
cat .trellis/spec/<package>/<layer>/index.md
|
||||
```
|
||||
Follow the **"Pre-Development Checklist"** section in the index.
|
||||
|
||||
4. **Read the specific guideline files** listed in the Pre-Development Checklist that are relevant to your task. The index is NOT the goal — it points you to the actual guideline files (e.g., `error-handling.md`, `conventions.md`, `mock-strategies.md`). Read those files to understand the coding standards and patterns.
|
||||
|
||||
5. **Always read shared guides**:
|
||||
```bash
|
||||
cat .trellis/spec/guides/index.md
|
||||
```
|
||||
|
||||
6. Understand the coding standards and patterns you need to follow, then proceed with your development plan.
|
||||
|
||||
This step is **mandatory** before writing any code.
|
||||
@@ -0,0 +1,538 @@
|
||||
---
|
||||
name: trellis-brainstorm
|
||||
description: "Guides collaborative requirements discovery before implementation. Creates task directory, seeds PRD, asks high-value questions one at a time, researches technical choices, and converges on MVP scope. Use when requirements are unclear, there are multiple valid approaches, or the user describes a new feature or complex task."
|
||||
---
|
||||
|
||||
# Brainstorm - Requirements Discovery (AI Coding Enhanced)
|
||||
|
||||
Guide AI through collaborative requirements discovery **before implementation**, optimized for AI coding workflows:
|
||||
|
||||
* **Task-first** (capture ideas immediately)
|
||||
* **Action-before-asking** (reduce low-value questions)
|
||||
* **Research-first** for technical choices (avoid asking users to invent options)
|
||||
* **Diverge → Converge** (expand thinking, then lock MVP)
|
||||
|
||||
---
|
||||
|
||||
## When to Use
|
||||
|
||||
Triggered from /trellis:start when the user describes a development task, especially when:
|
||||
|
||||
* requirements are unclear or evolving
|
||||
* there are multiple valid implementation paths
|
||||
* trade-offs matter (UX, reliability, maintainability, cost, performance)
|
||||
* the user might not know the best options up front
|
||||
|
||||
---
|
||||
|
||||
## Core Principles (Non-negotiable)
|
||||
|
||||
1. **Task-first (capture early)**
|
||||
Always ensure a task exists at the start so the user's ideas are recorded immediately.
|
||||
|
||||
2. **Action before asking**
|
||||
If you can derive the answer from repo code, docs, configs, conventions, or quick research — do that first.
|
||||
|
||||
3. **One question per message**
|
||||
Never overwhelm the user with a list of questions. Ask one, update PRD, repeat.
|
||||
|
||||
4. **Prefer concrete options**
|
||||
For preference/decision questions, present 2–3 feasible, specific approaches with trade-offs.
|
||||
|
||||
5. **Research-first for technical choices**
|
||||
If the decision depends on industry conventions / similar tools / established patterns, do research first, then propose options.
|
||||
|
||||
6. **Diverge → Converge**
|
||||
After initial understanding, proactively consider future evolution, related scenarios, and failure/edge cases — then converge to an MVP with explicit out-of-scope.
|
||||
|
||||
7. **No meta questions**
|
||||
Do not ask "should I search?" or "can you paste the code so I can continue?"
|
||||
If you need information: search/inspect. If blocked: ask the minimal blocking question.
|
||||
|
||||
---
|
||||
|
||||
## Step 0: Ensure Task Exists (ALWAYS)
|
||||
|
||||
Before any Q&A, ensure a task exists. If none exists, create one immediately.
|
||||
|
||||
* Use a **temporary working title** derived from the user's message.
|
||||
* It's OK if the title is imperfect — refine later in PRD.
|
||||
|
||||
```bash
|
||||
TASK_DIR=$(python3 ./.trellis/scripts/task.py create "brainstorm: <short goal>" --slug <auto>)
|
||||
```
|
||||
|
||||
Use a slug without a date prefix. `task.py create` adds the `MM-DD-`
|
||||
directory prefix automatically.
|
||||
|
||||
Create/seed `prd.md` immediately with what you know:
|
||||
|
||||
```markdown
|
||||
# brainstorm: <short goal>
|
||||
|
||||
## Goal
|
||||
|
||||
<one paragraph: what + why>
|
||||
|
||||
## What I already know
|
||||
|
||||
* <facts from user message>
|
||||
* <facts discovered from repo/docs>
|
||||
|
||||
## Assumptions (temporary)
|
||||
|
||||
* <assumptions to validate>
|
||||
|
||||
## Open Questions
|
||||
|
||||
* <ONLY Blocking / Preference questions; keep list short>
|
||||
|
||||
## Requirements (evolving)
|
||||
|
||||
* <start with what is known>
|
||||
|
||||
## Acceptance Criteria (evolving)
|
||||
|
||||
* [ ] <testable criterion>
|
||||
|
||||
## Definition of Done (team quality bar)
|
||||
|
||||
* Tests added/updated (unit/integration where appropriate)
|
||||
* Lint / typecheck / CI green
|
||||
* Docs/notes updated if behavior changes
|
||||
* Rollout/rollback considered if risky
|
||||
|
||||
## Out of Scope (explicit)
|
||||
|
||||
* <what we will not do in this task>
|
||||
|
||||
## Technical Notes
|
||||
|
||||
* <files inspected, constraints, links, references>
|
||||
* <research notes summary if applicable>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Auto-Context (DO THIS BEFORE ASKING QUESTIONS)
|
||||
|
||||
Before asking questions like "what does the code look like?", gather context yourself:
|
||||
|
||||
### Repo inspection checklist
|
||||
|
||||
* Identify likely modules/files impacted
|
||||
* Locate existing patterns (similar features, conventions, error handling style)
|
||||
* Check configs, scripts, existing command definitions
|
||||
* Note any constraints (runtime, dependency policy, build tooling)
|
||||
|
||||
### Documentation checklist
|
||||
|
||||
* Look for existing PRDs/specs/templates
|
||||
* Look for command usage examples, README, ADRs if any
|
||||
|
||||
Write findings into PRD:
|
||||
|
||||
* Add to `What I already know`
|
||||
* Add constraints/links to `Technical Notes`
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Classify Complexity (still useful, not gating task creation)
|
||||
|
||||
| Complexity | Criteria | Action |
|
||||
| ------------ | ------------------------------------------------------ | ------------------------------------------- |
|
||||
| **Trivial** | Single-line fix, typo, obvious change | Skip brainstorm, implement directly |
|
||||
| **Simple** | Clear goal, 1–2 files, scope well-defined | Ask 1 confirm question, then implement |
|
||||
| **Moderate** | Multiple files, some ambiguity | Light brainstorm (2–3 high-value questions) |
|
||||
| **Complex** | Vague goal, architectural choices, multiple approaches | Full brainstorm |
|
||||
|
||||
> Note: Task already exists from Step 0. Classification only affects depth of brainstorming.
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Question Gate (Ask ONLY high-value questions)
|
||||
|
||||
Before asking ANY question, run the following gate:
|
||||
|
||||
### Gate A — Can I derive this without the user?
|
||||
|
||||
If answer is available via:
|
||||
|
||||
* repo inspection (code/config)
|
||||
* docs/specs/conventions
|
||||
* quick market/OSS research
|
||||
|
||||
→ **Do not ask.** Fetch it, summarize, update PRD.
|
||||
|
||||
### Gate B — Is this a meta/lazy question?
|
||||
|
||||
Examples:
|
||||
|
||||
* "Should I search?"
|
||||
* "Can you paste the code so I can proceed?"
|
||||
* "What does the code look like?" (when repo is available)
|
||||
|
||||
→ **Do not ask.** Take action.
|
||||
|
||||
### Gate C — What type of question is it?
|
||||
|
||||
* **Blocking**: cannot proceed without user input
|
||||
* **Preference**: multiple valid choices, depends on product/UX/risk preference
|
||||
* **Derivable**: should be answered by inspection/research
|
||||
|
||||
→ Only ask **Blocking** or **Preference**.
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Research-first Mode (Mandatory for technical choices)
|
||||
|
||||
### Trigger conditions (any → research-first)
|
||||
|
||||
* The task involves selecting an approach, library, protocol, framework, template system, plugin mechanism, or CLI UX convention
|
||||
* The user asks for "best practice", "how others do it", "recommendation"
|
||||
* The user can't reasonably enumerate options
|
||||
|
||||
### Delegate to `trellis-research` sub-agent (don't research inline)
|
||||
|
||||
For each research topic, **spawn a `trellis-research` sub-agent via the Task tool** — don't do WebFetch / WebSearch / `gh api` inline in the main conversation.
|
||||
|
||||
Why:
|
||||
- The sub-agent has its own context window → doesn't pollute brainstorm context with raw tool output
|
||||
- It persists findings to `{TASK_DIR}/research/<topic>.md` (the contract — see `workflow.md` Phase 1.2)
|
||||
- It returns only `{file path, one-line summary}` to the main agent
|
||||
- Independent topics can be **parallelized** — spawn multiple sub-agents in one tool call
|
||||
|
||||
Agent type: `trellis-research`
|
||||
Task description template: "Research <specific question>; persist findings to `{TASK_DIR}/research/<topic-slug>.md`."
|
||||
|
||||
❌ Bad (what you must NOT do):
|
||||
```
|
||||
Main agent: WebFetch(url-A) → WebFetch(url-B) → Bash(gh api ...)
|
||||
→ WebSearch(q1) → WebSearch(q2) → ... (10+ inline calls)
|
||||
→ Write(research/topic.md)
|
||||
```
|
||||
→ Pollutes main context with raw HTML/JSON, burns tokens.
|
||||
|
||||
✅ Good:
|
||||
```
|
||||
Main agent: Task(subagent_type="trellis-research",
|
||||
prompt="Research topic A; persist to research/topic-a.md")
|
||||
+ Task(subagent_type="trellis-research",
|
||||
prompt="Research topic B; persist to research/topic-b.md")
|
||||
+ Task(subagent_type="trellis-research",
|
||||
prompt="Research topic C; persist to research/topic-c.md")
|
||||
→ Reads research/topic-{a,b,c}.md after they finish.
|
||||
```
|
||||
|
||||
### Research steps (to pass into each sub-agent prompt)
|
||||
|
||||
Each `trellis-research` sub-agent should:
|
||||
|
||||
1. Identify 2–4 comparable tools/patterns for its topic
|
||||
2. Summarize common conventions and why they exist
|
||||
3. Map conventions onto our repo constraints
|
||||
4. Write findings to `{TASK_DIR}/research/<topic>.md`
|
||||
|
||||
Main agent then reads the persisted files and produces **2–3 feasible approaches** in PRD.
|
||||
|
||||
### Research output format (PRD)
|
||||
|
||||
The PRD itself should only reference the persisted research files, not duplicate their content. Add a `## Research References` section pointing at `research/*.md`.
|
||||
|
||||
Optionally, add a convergence section with feasible approaches derived from the research:
|
||||
|
||||
```markdown
|
||||
## Research References
|
||||
|
||||
* [`research/<topic-a>.md`](research/<topic-a>.md) — <one-line takeaway>
|
||||
* [`research/<topic-b>.md`](research/<topic-b>.md) — <one-line takeaway>
|
||||
|
||||
## Research Notes
|
||||
|
||||
### What similar tools do
|
||||
|
||||
* ...
|
||||
* ...
|
||||
|
||||
### Constraints from our repo/project
|
||||
|
||||
* ...
|
||||
|
||||
### Feasible approaches here
|
||||
|
||||
**Approach A: <name>** (Recommended)
|
||||
|
||||
* How it works:
|
||||
* Pros:
|
||||
* Cons:
|
||||
|
||||
**Approach B: <name>**
|
||||
|
||||
* How it works:
|
||||
* Pros:
|
||||
* Cons:
|
||||
|
||||
**Approach C: <name>** (optional)
|
||||
|
||||
* ...
|
||||
```
|
||||
|
||||
Then ask **one** preference question:
|
||||
|
||||
* "Which approach do you prefer: A / B / C (or other)?"
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Expansion Sweep (DIVERGE) — Required after initial understanding
|
||||
|
||||
After you can summarize the goal, proactively broaden thinking before converging.
|
||||
|
||||
### Expansion categories (keep to 1–2 bullets each)
|
||||
|
||||
1. **Future evolution**
|
||||
|
||||
* What might this feature become in 1–3 months?
|
||||
* What extension points are worth preserving now?
|
||||
|
||||
2. **Related scenarios**
|
||||
|
||||
* What adjacent commands/flows should remain consistent with this?
|
||||
* Are there parity expectations (create vs update, import vs export, etc.)?
|
||||
|
||||
3. **Failure & edge cases**
|
||||
|
||||
* Conflicts, offline/network failure, retries, idempotency, compatibility, rollback
|
||||
* Input validation, security boundaries, permission checks
|
||||
|
||||
### Expansion message template (to user)
|
||||
|
||||
```markdown
|
||||
I understand you want to implement: <current goal>.
|
||||
|
||||
Before diving into design, let me quickly diverge to consider three categories (to avoid rework later):
|
||||
|
||||
1. Future evolution: <1–2 bullets>
|
||||
2. Related scenarios: <1–2 bullets>
|
||||
3. Failure/edge cases: <1–2 bullets>
|
||||
|
||||
For this MVP, which would you like to include (or none)?
|
||||
|
||||
1. Current requirement only (minimal viable)
|
||||
2. Add <X> (reserve for future extension)
|
||||
3. Add <Y> (improve robustness/consistency)
|
||||
4. Other: describe your preference
|
||||
```
|
||||
|
||||
Then update PRD:
|
||||
|
||||
* What's in MVP → `Requirements`
|
||||
* What's excluded → `Out of Scope`
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Q&A Loop (CONVERGE)
|
||||
|
||||
### Rules
|
||||
|
||||
* One question per message
|
||||
* Prefer multiple-choice when possible
|
||||
* After each user answer:
|
||||
|
||||
* Update PRD immediately
|
||||
* Move answered items from `Open Questions` → `Requirements`
|
||||
* Update `Acceptance Criteria` with testable checkboxes
|
||||
* Clarify `Out of Scope`
|
||||
|
||||
### Question priority (recommended)
|
||||
|
||||
1. **MVP scope boundary** (what is included/excluded)
|
||||
2. **Preference decisions** (after presenting concrete options)
|
||||
3. **Failure/edge behavior** (only for MVP-critical paths)
|
||||
4. **Success metrics & Acceptance Criteria** (what proves it works)
|
||||
|
||||
### Preferred question format (multiple choice)
|
||||
|
||||
```markdown
|
||||
For <topic>, which approach do you prefer?
|
||||
|
||||
1. **Option A** — <what it means + trade-off>
|
||||
2. **Option B** — <what it means + trade-off>
|
||||
3. **Option C** — <what it means + trade-off>
|
||||
4. **Other** — describe your preference
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 7: Propose Approaches + Record Decisions (Complex tasks)
|
||||
|
||||
After requirements are clear enough, propose 2–3 approaches (if not already done via research-first):
|
||||
|
||||
```markdown
|
||||
Based on current information, here are 2–3 feasible approaches:
|
||||
|
||||
**Approach A: <name>** (Recommended)
|
||||
|
||||
* How:
|
||||
* Pros:
|
||||
* Cons:
|
||||
|
||||
**Approach B: <name>**
|
||||
|
||||
* How:
|
||||
* Pros:
|
||||
* Cons:
|
||||
|
||||
Which direction do you prefer?
|
||||
```
|
||||
|
||||
Record the outcome in PRD as an ADR-lite section:
|
||||
|
||||
```markdown
|
||||
## Decision (ADR-lite)
|
||||
|
||||
**Context**: Why this decision was needed
|
||||
**Decision**: Which approach was chosen
|
||||
**Consequences**: Trade-offs, risks, potential future improvements
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 8: Final Confirmation + Implementation Plan
|
||||
|
||||
When open questions are resolved, confirm complete requirements with a structured summary:
|
||||
|
||||
### Final confirmation format
|
||||
|
||||
```markdown
|
||||
Here's my understanding of the complete requirements:
|
||||
|
||||
**Goal**: <one sentence>
|
||||
|
||||
**Requirements**:
|
||||
|
||||
* ...
|
||||
* ...
|
||||
|
||||
**Acceptance Criteria**:
|
||||
|
||||
* [ ] ...
|
||||
* [ ] ...
|
||||
|
||||
**Definition of Done**:
|
||||
|
||||
* ...
|
||||
|
||||
**Out of Scope**:
|
||||
|
||||
* ...
|
||||
|
||||
**Technical Approach**:
|
||||
<brief summary + key decisions>
|
||||
|
||||
**Implementation Plan (small PRs)**:
|
||||
|
||||
* PR1: <scaffolding + tests + minimal plumbing>
|
||||
* PR2: <core behavior>
|
||||
* PR3: <edge cases + docs + cleanup>
|
||||
|
||||
Does this look correct? If yes, I'll proceed with implementation.
|
||||
```
|
||||
|
||||
### Subtask Decomposition (Complex Tasks)
|
||||
|
||||
For complex tasks with multiple independent work items, create subtasks:
|
||||
|
||||
```bash
|
||||
# Create child tasks
|
||||
CHILD1=$(python3 ./.trellis/scripts/task.py create "Child task 1" --slug child1 --parent "$TASK_DIR")
|
||||
CHILD2=$(python3 ./.trellis/scripts/task.py create "Child task 2" --slug child2 --parent "$TASK_DIR")
|
||||
|
||||
# Or link existing tasks
|
||||
python3 ./.trellis/scripts/task.py add-subtask "$TASK_DIR" "$CHILD_DIR"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## PRD Target Structure (final)
|
||||
|
||||
`prd.md` should converge to:
|
||||
|
||||
```markdown
|
||||
# <Task Title>
|
||||
|
||||
## Goal
|
||||
|
||||
<why + what>
|
||||
|
||||
## Requirements
|
||||
|
||||
* ...
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
* [ ] ...
|
||||
|
||||
## Definition of Done
|
||||
|
||||
* ...
|
||||
|
||||
## Technical Approach
|
||||
|
||||
<key design + decisions>
|
||||
|
||||
## Decision (ADR-lite)
|
||||
|
||||
Context / Decision / Consequences
|
||||
|
||||
## Out of Scope
|
||||
|
||||
* ...
|
||||
|
||||
## Technical Notes
|
||||
|
||||
<constraints, references, files, research notes>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Anti-Patterns (Hard Avoid)
|
||||
|
||||
* Asking user for code/context that can be derived from repo
|
||||
* Asking user to choose an approach before presenting concrete options
|
||||
* Meta questions about whether to research
|
||||
* Staying narrowly on the initial request without considering evolution/edges
|
||||
* Letting brainstorming drift without updating PRD
|
||||
|
||||
---
|
||||
|
||||
## Integration with Start Workflow
|
||||
|
||||
After brainstorm completes (Step 8 confirmation approved), the flow continues to the Task Workflow's **Phase 2: Prepare for Implementation**:
|
||||
|
||||
```text
|
||||
Brainstorm
|
||||
Step 0: Create task directory + seed PRD
|
||||
Step 1–7: Discover requirements, research, converge
|
||||
Step 8: Final confirmation → user approves
|
||||
↓
|
||||
Task Workflow Phase 2 (Prepare for Implementation)
|
||||
Code-Spec Depth Check (if applicable)
|
||||
→ Research codebase (based on confirmed PRD)
|
||||
→ Configure code-spec context (jsonl files)
|
||||
→ Activate task
|
||||
↓
|
||||
Task Workflow Phase 3 (Execute)
|
||||
Implement → Check → Complete
|
||||
```
|
||||
|
||||
The task directory and PRD already exist from brainstorm, so Phase 1 of the Task Workflow is skipped entirely.
|
||||
|
||||
---
|
||||
|
||||
## Related Commands
|
||||
|
||||
| Command | When to Use |
|
||||
|---------|-------------|
|
||||
| `/trellis:start` | Entry point that triggers brainstorm |
|
||||
| `/trellis:finish-work` | After implementation is complete |
|
||||
| `/trellis:update-spec` | If new patterns emerge during work |
|
||||
@@ -0,0 +1,130 @@
|
||||
---
|
||||
name: trellis-break-loop
|
||||
description: "Deep bug analysis to break the fix-forget-repeat cycle. Analyzes root cause category, why fixes failed, prevention mechanisms, and captures knowledge into specs. Use after fixing a bug to prevent the same class of bugs."
|
||||
---
|
||||
|
||||
# Break the Loop - Deep Bug Analysis
|
||||
|
||||
When debug is complete, use this for deep analysis to break the "fix bug -> forget -> repeat" cycle.
|
||||
|
||||
---
|
||||
|
||||
## Analysis Framework
|
||||
|
||||
Analyze the bug you just fixed from these 5 dimensions:
|
||||
|
||||
### 1. Root Cause Category
|
||||
|
||||
Which category does this bug belong to?
|
||||
|
||||
| Category | Characteristics | Example |
|
||||
|----------|-----------------|---------|
|
||||
| **A. Missing Spec** | No documentation on how to do it | New feature without checklist |
|
||||
| **B. Cross-Layer Contract** | Interface between layers unclear | API returns different format than expected |
|
||||
| **C. Change Propagation Failure** | Changed one place, missed others | Changed function signature, missed call sites |
|
||||
| **D. Test Coverage Gap** | Unit test passes, integration fails | Works alone, breaks when combined |
|
||||
| **E. Implicit Assumption** | Code relies on undocumented assumption | Timestamp seconds vs milliseconds |
|
||||
|
||||
### 2. Why Fixes Failed (if applicable)
|
||||
|
||||
If you tried multiple fixes before succeeding, analyze each failure:
|
||||
|
||||
- **Surface Fix**: Fixed symptom, not root cause
|
||||
- **Incomplete Scope**: Found root cause, didn't cover all cases
|
||||
- **Tool Limitation**: grep missed it, type check wasn't strict
|
||||
- **Mental Model**: Kept looking in same layer, didn't think cross-layer
|
||||
|
||||
### 3. Prevention Mechanisms
|
||||
|
||||
What mechanisms would prevent this from happening again?
|
||||
|
||||
| Type | Description | Example |
|
||||
|------|-------------|---------|
|
||||
| **Documentation** | Write it down so people know | Update thinking guide |
|
||||
| **Architecture** | Make the error impossible structurally | Type-safe wrappers |
|
||||
| **Compile-time** | Strict type checking, no escape hatches | Signature change causes compile error |
|
||||
| **Runtime** | Monitoring, alerts, scans | Detect orphan entities |
|
||||
| **Test Coverage** | E2E tests, integration tests | Verify full flow |
|
||||
| **Code Review** | Checklist, PR template | "Did you check X?" |
|
||||
|
||||
### 4. Systematic Expansion
|
||||
|
||||
What broader problems does this bug reveal?
|
||||
|
||||
- **Similar Issues**: Where else might this problem exist?
|
||||
- **Design Flaw**: Is there a fundamental architecture issue?
|
||||
- **Process Flaw**: Is there a development process improvement?
|
||||
- **Knowledge Gap**: Is the team missing some understanding?
|
||||
|
||||
### 5. Knowledge Capture
|
||||
|
||||
Solidify insights into the system:
|
||||
|
||||
- [ ] Update `.trellis/spec/guides/` thinking guides
|
||||
- [ ] Update relevant `.trellis/spec/` docs
|
||||
- [ ] Create issue record (if applicable)
|
||||
- [ ] Create feature ticket for root fix
|
||||
- [ ] Update check guidelines if needed
|
||||
|
||||
---
|
||||
|
||||
## Output Format
|
||||
|
||||
Please output analysis in this format:
|
||||
|
||||
```markdown
|
||||
## Bug Analysis: [Short Description]
|
||||
|
||||
### 1. Root Cause Category
|
||||
- **Category**: [A/B/C/D/E] - [Category Name]
|
||||
- **Specific Cause**: [Detailed description]
|
||||
|
||||
### 2. Why Fixes Failed (if applicable)
|
||||
1. [First attempt]: [Why it failed]
|
||||
2. [Second attempt]: [Why it failed]
|
||||
...
|
||||
|
||||
### 3. Prevention Mechanisms
|
||||
| Priority | Mechanism | Specific Action | Status |
|
||||
|----------|-----------|-----------------|--------|
|
||||
| P0 | ... | ... | TODO/DONE |
|
||||
|
||||
### 4. Systematic Expansion
|
||||
- **Similar Issues**: [List places with similar problems]
|
||||
- **Design Improvement**: [Architecture-level suggestions]
|
||||
- **Process Improvement**: [Development process suggestions]
|
||||
|
||||
### 5. Knowledge Capture
|
||||
- [ ] [Documents to update / tickets to create]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
> **The value of debugging is not in fixing the bug, but in making this class of bugs never happen again.**
|
||||
|
||||
Three levels of insight:
|
||||
1. **Tactical**: How to fix THIS bug
|
||||
2. **Strategic**: How to prevent THIS CLASS of bugs
|
||||
3. **Philosophical**: How to expand thinking patterns
|
||||
|
||||
30 minutes of analysis saves 30 hours of future debugging.
|
||||
|
||||
---
|
||||
|
||||
## After Analysis: Immediate Actions
|
||||
|
||||
**IMPORTANT**: After completing the analysis above, you MUST immediately:
|
||||
|
||||
1. **Update spec/guides** - Don't just list TODOs, actually update the relevant files:
|
||||
- If it's a cross-platform issue → update `cross-platform-thinking-guide.md`
|
||||
- If it's a cross-layer issue → update `cross-layer-thinking-guide.md`
|
||||
- If it's a code reuse issue → update `code-reuse-thinking-guide.md`
|
||||
- If it's domain-specific → update `backend/*.md` or `frontend/*.md`
|
||||
|
||||
2. **Sync templates** - After updating `.trellis/spec/`, sync to `src/templates/markdown/spec/`
|
||||
|
||||
3. **Commit the spec updates** - This is the primary output, not just the analysis text
|
||||
|
||||
> **The analysis is worthless if it stays in chat. The value is in the updated specs.**
|
||||
@@ -0,0 +1,92 @@
|
||||
---
|
||||
name: trellis-check
|
||||
description: "Comprehensive quality verification: spec compliance, lint, type-check, tests, cross-layer data flow, code reuse, and consistency checks. Use when code is written and needs quality verification, before committing changes, or to catch context drift during long sessions."
|
||||
---
|
||||
|
||||
# Code Quality Check
|
||||
|
||||
Comprehensive quality verification for recently written code. Combines spec compliance, cross-layer safety, and pre-commit checks.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Identify What Changed
|
||||
|
||||
```bash
|
||||
git diff --name-only HEAD
|
||||
git status
|
||||
```
|
||||
|
||||
## Step 2: Read Applicable Specs
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode packages
|
||||
```
|
||||
|
||||
For each changed package/layer, read the spec index and follow its **Quality Check** section:
|
||||
|
||||
```bash
|
||||
cat .trellis/spec/<package>/<layer>/index.md
|
||||
```
|
||||
|
||||
Read the specific guideline files referenced — the index is a pointer, not the goal.
|
||||
|
||||
## Step 3: Run Project Checks
|
||||
|
||||
Run the project's lint, type-check, and test commands. Fix any failures before proceeding.
|
||||
|
||||
## Step 4: Review Against Checklist
|
||||
|
||||
### Code Quality
|
||||
|
||||
- [ ] Linter passes?
|
||||
- [ ] Type checker passes (if applicable)?
|
||||
- [ ] Tests pass?
|
||||
- [ ] No debug logging left in?
|
||||
- [ ] No suppressed warnings or type-safety bypasses?
|
||||
|
||||
### Test Coverage
|
||||
|
||||
- [ ] New function → unit test added?
|
||||
- [ ] Bug fix → regression test added?
|
||||
- [ ] Changed behavior → existing tests updated?
|
||||
|
||||
### Spec Sync
|
||||
|
||||
- [ ] Does `.trellis/spec/` need updates? (new patterns, conventions, lessons learned)
|
||||
|
||||
> "If I fixed a bug or discovered something non-obvious, should I document it so future me won't hit the same issue?" → If YES, update the relevant spec doc.
|
||||
|
||||
## Step 5: Cross-Layer Dimensions (if applicable)
|
||||
|
||||
Skip this step if your change is confined to a single layer.
|
||||
|
||||
### A. Data Flow (changes touch 3+ layers)
|
||||
|
||||
- [ ] Read flow traces correctly: Storage → Service → API → UI
|
||||
- [ ] Write flow traces correctly: UI → API → Service → Storage
|
||||
- [ ] Types/schemas correctly passed between layers?
|
||||
- [ ] Errors properly propagated to caller?
|
||||
|
||||
### B. Code Reuse (modifying constants, creating utilities)
|
||||
|
||||
- [ ] Searched for existing similar code before creating new?
|
||||
```bash
|
||||
grep -r "pattern" src/
|
||||
```
|
||||
- [ ] If 2+ places define same value → extracted to shared constant?
|
||||
- [ ] After batch modification, all occurrences updated?
|
||||
|
||||
### C. Import/Dependency (creating new files)
|
||||
|
||||
- [ ] Correct import paths (relative vs absolute)?
|
||||
- [ ] No circular dependencies?
|
||||
|
||||
### D. Same-Layer Consistency
|
||||
|
||||
- [ ] Other places using the same concept are consistent?
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Report and Fix
|
||||
|
||||
Report violations found and fix them directly. Re-run project checks after fixes.
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
name: trellis-meta
|
||||
description: "Understand and customize the local Trellis architecture inside a user project. Use when modifying .trellis plus platform hooks, settings, agents, skills, commands, prompts, or workflows generated by trellis init."
|
||||
---
|
||||
|
||||
# Trellis Meta
|
||||
|
||||
This skill is for local Trellis users who have already run `trellis init` in a project. After reading it, an AI should understand the Trellis architecture, operating model, and customization entry points inside that user project, then modify the generated `.trellis/` and platform directory files according to the user's request.
|
||||
|
||||
The default operating scope is local files in the user project:
|
||||
|
||||
- `.trellis/`: workflow, config, tasks, spec, workspace, scripts, and runtime state.
|
||||
- Platform directories: `.claude/`, `.codex/`, `.cursor/`, `.opencode/`, `.kiro/`, `.gemini/`, `.qoder/`, `.codebuddy/`, `.github/`, `.factory/`, `.pi/`, `.kilocode/`, `.agent/`, `.windsurf/`, and similar directories.
|
||||
- Shared skill layer: `.agents/skills/`.
|
||||
|
||||
Do not assume the user has the Trellis source repository. Do not default to modifying the global npm install directory or `node_modules`.
|
||||
|
||||
## How To Use
|
||||
|
||||
1. Read `references/local-architecture/overview.md` first to establish the local Trellis system model.
|
||||
2. If the request involves a specific AI tool, read `references/platform-files/platform-map.md` and the relevant platform file notes.
|
||||
3. If the user wants to change behavior, read `references/customize-local/overview.md`, then open the specific customization topic.
|
||||
4. Before editing, read the actual files in the user project and treat local content as authoritative.
|
||||
|
||||
## References
|
||||
|
||||
### Local Architecture
|
||||
|
||||
- `references/local-architecture/overview.md`: The three-layer local Trellis architecture and customization principles.
|
||||
- `references/local-architecture/generated-files.md`: Files generated by `trellis init` and their customization boundaries.
|
||||
- `references/local-architecture/workflow.md`: Phases, routing, and workflow-state blocks in `.trellis/workflow.md`.
|
||||
- `references/local-architecture/task-system.md`: Task directories, active tasks, JSONL context, and task runtime.
|
||||
- `references/local-architecture/spec-system.md`: How `.trellis/spec/` is organized and injected.
|
||||
- `references/local-architecture/workspace-memory.md`: `.trellis/workspace/`, journals, and cross-session memory.
|
||||
- `references/local-architecture/context-injection.md`: Hooks, sub-agent preludes, and context injection paths.
|
||||
|
||||
### Platform Files
|
||||
|
||||
- `references/platform-files/overview.md`: How shared `.trellis/` files relate to platform directories.
|
||||
- `references/platform-files/platform-map.md`: Platform directories and paths for skills, agents, hooks, and extensions.
|
||||
- `references/platform-files/hooks-and-settings.md`: How settings/config files, hooks, plugins, and extensions connect to Trellis.
|
||||
- `references/platform-files/agents.md`: Local file responsibilities for `trellis-research`, `trellis-implement`, and `trellis-check`.
|
||||
- `references/platform-files/skills-and-commands.md`: Differences between skills, commands, prompts, and workflows, plus how to change them.
|
||||
|
||||
### Local Customization
|
||||
|
||||
- `references/customize-local/overview.md`: Choose the right local customization entry point for the user's request.
|
||||
- `references/customize-local/change-workflow.md`: Change phases, routing, next actions, and workflow-state.
|
||||
- `references/customize-local/change-task-lifecycle.md`: Change task creation, status, archive behavior, and hooks.
|
||||
- `references/customize-local/change-context-loading.md`: Change how tasks, specs, journals, and hook context are loaded.
|
||||
- `references/customize-local/change-hooks.md`: Change platform hooks, settings, and shell session bridges.
|
||||
- `references/customize-local/change-agents.md`: Change research, implement, and check agent behavior.
|
||||
- `references/customize-local/change-skills-or-commands.md`: Add or modify local skills, commands, prompts, and workflows.
|
||||
- `references/customize-local/change-spec-structure.md`: Adjust the project spec structure under `.trellis/spec/`.
|
||||
- `references/customize-local/add-project-local-conventions.md`: Put team rules into project-local specs or local skills.
|
||||
|
||||
## Current Rules
|
||||
|
||||
- `.trellis/workflow.md` is the local workflow source of truth.
|
||||
- `.trellis/config.yaml` is the project-level Trellis configuration and task hook configuration entry point.
|
||||
- `.trellis/spec/` stores the user's project-specific coding conventions and design constraints.
|
||||
- `.trellis/tasks/` stores task PRDs, technical notes, research files, and JSONL context.
|
||||
- `.trellis/workspace/` stores developer journals and cross-session memory.
|
||||
- Platform settings/config files decide which hooks, agents, skills, commands, prompts, and workflows actually run.
|
||||
- `.trellis/.template-hashes.json` and `.trellis/.runtime/` are management/runtime state files. Confirm necessity before editing them.
|
||||
|
||||
## Do Not
|
||||
|
||||
- Do not treat Trellis upstream source code as the default target for local customization.
|
||||
- Do not modify the global npm install directory or `node_modules/@mindfoldhq/trellis` to implement project needs.
|
||||
- Do not overwrite user-modified local files with default templates.
|
||||
- Do not put team-private project rules into the public `trellis-meta`; put project rules in `.trellis/spec/` or a project-local skill.
|
||||
- Do not describe removed historical mechanisms as current Trellis behavior.
|
||||
+83
@@ -0,0 +1,83 @@
|
||||
# Add Project-Local Conventions
|
||||
|
||||
Often the user does not need to change Trellis mechanics; they need local AI to understand their team's conventions. In that case, prefer `.trellis/spec/` or a project-local skill instead of editing `trellis-meta`.
|
||||
|
||||
## Where To Put Things
|
||||
|
||||
| Content type | Location |
|
||||
| --- | --- |
|
||||
| Rules code must follow | `.trellis/spec/<layer>/` |
|
||||
| Cross-layer thinking methods | `.trellis/spec/guides/` |
|
||||
| AI capability for a project-specific flow | Platform-local skill |
|
||||
| One-off task material | `.trellis/tasks/<task>/` |
|
||||
| Session summary | `.trellis/workspace/<developer>/journal-N.md` |
|
||||
|
||||
## Create A Project-Local Skill
|
||||
|
||||
If the user wants AI to know "how this project customizes Trellis," create a local skill:
|
||||
|
||||
```text
|
||||
.claude/skills/trellis-local/
|
||||
└── SKILL.md
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```md
|
||||
---
|
||||
name: trellis-local
|
||||
description: "Project-local Trellis customizations for this repository. Use when changing this project's Trellis workflow, hooks, local agents, or team-specific conventions."
|
||||
---
|
||||
|
||||
# Trellis Local
|
||||
|
||||
## Local Scope
|
||||
|
||||
This skill documents this repository's Trellis customizations only.
|
||||
|
||||
## Custom Workflow Rules
|
||||
|
||||
- ...
|
||||
|
||||
## Local Hook Changes
|
||||
|
||||
- ...
|
||||
|
||||
## Local Agent Changes
|
||||
|
||||
- ...
|
||||
```
|
||||
|
||||
For multi-platform projects, place equivalent versions in other platform skill directories, or use `.agents/skills/` for platforms that support the shared layer.
|
||||
|
||||
## Write To `.trellis/spec/`
|
||||
|
||||
If the content is a coding convention, write it to spec. Examples:
|
||||
|
||||
```text
|
||||
.trellis/spec/backend/error-handling.md
|
||||
.trellis/spec/frontend/components.md
|
||||
.trellis/spec/guides/cross-platform-thinking-guide.md
|
||||
```
|
||||
|
||||
After writing it, update the corresponding `index.md` so AI can find the new rule from the entry point.
|
||||
|
||||
## Make The Current Task Use New Conventions
|
||||
|
||||
After writing a spec, add it to the current task context:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py add-context <task> implement ".trellis/spec/backend/error-handling.md" "Error handling conventions"
|
||||
python3 ./.trellis/scripts/task.py add-context <task> check ".trellis/spec/backend/error-handling.md" "Review error handling"
|
||||
```
|
||||
|
||||
## Do Not Store Project-Private Rules In `trellis-meta`
|
||||
|
||||
`trellis-meta` is a public skill for understanding Trellis architecture and local customization entry points. Put project-private content in:
|
||||
|
||||
- `.trellis/spec/`
|
||||
- a project-local skill
|
||||
- the current task
|
||||
- workspace journal
|
||||
|
||||
This prevents future updates to Trellis's built-in `trellis-meta` from overwriting the team's own conventions.
|
||||
@@ -0,0 +1,54 @@
|
||||
# Change Local Agents
|
||||
|
||||
When the user wants to change `trellis-research`, `trellis-implement`, or `trellis-check` behavior, edit platform agent files in the user project.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. Target platform agent directory
|
||||
2. `.trellis/workflow.md` Phase 2 / research routing
|
||||
3. Current task `prd.md`
|
||||
4. Current task `implement.jsonl` / `check.jsonl`
|
||||
5. Relevant hook or agent prelude
|
||||
|
||||
## Common Paths
|
||||
|
||||
| Platform | Path |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/agents/trellis-*.md` |
|
||||
| Cursor | `.cursor/agents/trellis-*.md` |
|
||||
| OpenCode | `.opencode/agents/trellis-*.md` |
|
||||
| Codex | `.codex/agents/trellis-*.toml` |
|
||||
| Kiro | `.kiro/agents/trellis-*.json` |
|
||||
| Gemini CLI | `.gemini/agents/trellis-*.md` |
|
||||
| Qoder | `.qoder/agents/trellis-*.md` |
|
||||
| CodeBuddy | `.codebuddy/agents/trellis-*.md` |
|
||||
| Factory Droid | `.factory/droids/trellis-*.md` |
|
||||
| Pi Agent | `.pi/agents/trellis-*.md` |
|
||||
|
||||
Use the actual paths in the user project as authoritative.
|
||||
|
||||
## Common Needs
|
||||
|
||||
| Need | Which agent to edit |
|
||||
| --- | --- |
|
||||
| Research must write files, not only reply in chat | `trellis-research` |
|
||||
| Certain local specs must be read before implementation | `trellis-implement` + `implement.jsonl` configuration rules |
|
||||
| Specific commands must run during checking | `trellis-check` |
|
||||
| Agent must not modify certain directories | The corresponding agent's write boundary instructions |
|
||||
| Agent output format must be fixed | The corresponding agent's final/reporting instructions |
|
||||
|
||||
## Modification Principles
|
||||
|
||||
1. **Preserve role boundaries**: research investigates and persists; implement writes implementation; check reviews and fixes.
|
||||
2. **Do not hard-code project specs into agents**: long-term specs belong in `.trellis/spec/`; agents are responsible for reading them.
|
||||
3. **Make read order explicit**: active task -> PRD -> info -> JSONL -> spec/research.
|
||||
4. **Make write boundaries explicit**: which directories may be written and which may not.
|
||||
5. **Synchronize across platforms**: when the user configured multiple platforms, decide whether to change only the current platform or all platform agents.
|
||||
|
||||
## Agent Pull Platforms
|
||||
|
||||
If an agent file contains a prelude for "read task/context after startup," do not remove those steps when editing. Otherwise the agent will work only from chat context and bypass Trellis's core mechanism.
|
||||
|
||||
## Hook Push Platforms
|
||||
|
||||
If context is injected by a hook, the agent file should still retain responsibility boundaries. Do not remove PRD/spec requirements from the agent just because a hook injects context.
|
||||
@@ -0,0 +1,81 @@
|
||||
# Change Local Context Loading
|
||||
|
||||
Context loading determines when AI reads workflow, task, spec, research, workspace, and git status. Read this page when the user says "AI does not know the current task," "the agent did not read specs," or "there is too much/too little context."
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. `.trellis/workflow.md`
|
||||
2. `.trellis/scripts/get_context.py`
|
||||
3. `.trellis/scripts/common/session_context.py`
|
||||
4. `.trellis/scripts/common/task_context.py`
|
||||
5. `.trellis/scripts/common/active_task.py`
|
||||
6. Current platform hooks or agent files
|
||||
7. The current task's `implement.jsonl` / `check.jsonl`
|
||||
|
||||
## Context Sources
|
||||
|
||||
| Source | Purpose |
|
||||
| --- | --- |
|
||||
| `.trellis/workflow.md` | Workflow and next-action hints. |
|
||||
| `.trellis/tasks/<task>/prd.md` | Current task requirements. |
|
||||
| `.trellis/tasks/<task>/implement.jsonl` | Spec/research to read before implementation. |
|
||||
| `.trellis/tasks/<task>/check.jsonl` | Spec/research to read during checking. |
|
||||
| `.trellis/spec/` | Project specs. |
|
||||
| `.trellis/workspace/` | Session records. |
|
||||
| git status | Current working tree changes. |
|
||||
|
||||
## Common Needs And Edit Points
|
||||
|
||||
| Need | Edit point |
|
||||
| --- | --- |
|
||||
| Inject more/less information in new sessions | `session_context.py` or the platform `session-start` hook. |
|
||||
| Change hints on each user input | `[workflow-state:STATUS]` block in `.trellis/workflow.md`. The `inject-workflow-state` hook is parser-only and reads the block verbatim. |
|
||||
| Agent did not read specs | Task JSONL, agent prelude, `inject-subagent-context` hook. |
|
||||
| Active task is lost | `active_task.py` and platform session identity propagation. |
|
||||
| Change JSONL validation rules | `task_context.py`. |
|
||||
|
||||
## JSONL Rules
|
||||
|
||||
`implement.jsonl` / `check.jsonl` are the key context loading interface:
|
||||
|
||||
```jsonl
|
||||
{"file": ".trellis/spec/backend/index.md", "reason": "Backend conventions"}
|
||||
{"file": ".trellis/tasks/04-28-x/research/api.md", "reason": "API research"}
|
||||
```
|
||||
|
||||
Include only spec/research files. Do not put code files that will be modified into these manifests; agents read code files themselves during implementation.
|
||||
|
||||
## Change Session Context
|
||||
|
||||
If the user wants every new session to see more project state, edit:
|
||||
|
||||
- `.trellis/scripts/common/session_context.py`
|
||||
- the corresponding platform `session-start` hook
|
||||
|
||||
Context cannot grow without bound. Prefer injecting indexes and paths so the AI can read detailed files on demand.
|
||||
|
||||
## Change Sub-Agent Context
|
||||
|
||||
First determine which mode the platform uses:
|
||||
|
||||
- hook push: edit the `inject-subagent-context` hook.
|
||||
- agent pull: edit the read steps in the corresponding `trellis-implement` / `trellis-check` agent file.
|
||||
|
||||
In both modes, make sure the agent ultimately reads:
|
||||
|
||||
1. active task
|
||||
2. `prd.md`
|
||||
3. `info.md` if present
|
||||
4. the corresponding JSONL
|
||||
5. spec/research referenced by the JSONL
|
||||
|
||||
## Troubleshooting Order
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py current --source
|
||||
python3 ./.trellis/scripts/task.py list-context <task>
|
||||
python3 ./.trellis/scripts/task.py validate <task>
|
||||
python3 ./.trellis/scripts/get_context.py --mode packages
|
||||
```
|
||||
|
||||
Confirm the task and JSONL are correct before editing hooks/agents.
|
||||
@@ -0,0 +1,57 @@
|
||||
# Change Local Hooks
|
||||
|
||||
Hooks are the automation layer that connects a platform to Trellis. When the user wants to change "when context is injected," "how shell commands inherit a session," or "which files are read before an agent starts," hooks are usually the edit point.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. Target platform settings/config, such as `.claude/settings.json`, `.codex/hooks.json`, `.cursor/hooks.json`
|
||||
2. Target platform hooks directory
|
||||
3. `.trellis/scripts/common/active_task.py`
|
||||
4. `.trellis/scripts/common/session_context.py`
|
||||
5. `.trellis/workflow.md`
|
||||
|
||||
## Common Hook Types
|
||||
|
||||
| Hook | Purpose |
|
||||
| --- | --- |
|
||||
| session-start | Injects a Trellis overview when a session starts, clears, or compacts. |
|
||||
| workflow-state | Injects a state hint on each user input. |
|
||||
| sub-agent context | Injects PRD/spec/research before an agent starts. |
|
||||
| shell session bridge | Lets `task.py` commands in shell see the same session identity. |
|
||||
|
||||
## Modification Steps
|
||||
|
||||
1. Find the hook registration in settings/config.
|
||||
2. Confirm the registered script path exists.
|
||||
3. Read the hook script and identify inputs, outputs, and called `.trellis/scripts/`.
|
||||
4. Modify hook behavior.
|
||||
5. If the hook depends on workflow content, synchronize `.trellis/workflow.md`.
|
||||
|
||||
## Example: Change New-Session Injection Content
|
||||
|
||||
First find the session-start hook:
|
||||
|
||||
```text
|
||||
.claude/settings.json
|
||||
.claude/hooks/session-start.py
|
||||
```
|
||||
|
||||
If the hook ultimately calls `.trellis/scripts/get_context.py` or `session_context.py`, editing the local script is usually more robust than hard-coding content in the hook.
|
||||
|
||||
## Example: Agent Did Not Read JSONL
|
||||
|
||||
First confirm:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py current --source
|
||||
python3 ./.trellis/scripts/task.py validate <task>
|
||||
```
|
||||
|
||||
If the task and JSONL are correct, determine whether the platform uses hook push or agent pull. For hook push, edit `inject-subagent-context`; for agent pull, edit the agent file.
|
||||
|
||||
## Notes
|
||||
|
||||
- Settings handle registration, hook scripts handle behavior; inspect both together.
|
||||
- Different platforms support different hook events. Do not directly copy another platform's settings.
|
||||
- Hooks should read project-local `.trellis/`; they should not depend on Trellis upstream source paths.
|
||||
- Hook failures should produce visible errors so AI does not silently lose context.
|
||||
@@ -0,0 +1,78 @@
|
||||
# Change Local Skills, Commands, Prompts, And Workflows
|
||||
|
||||
When the user wants to change AI entry points, auto-trigger rules, or explicit command behavior, edit skills, commands, prompts, or workflows in local platform directories.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. `.trellis/workflow.md`
|
||||
2. Target platform skill/command/prompt/workflow directory
|
||||
3. Related agent or hook files
|
||||
4. Whether project rules already exist in `.trellis/spec/`
|
||||
|
||||
## Which Entry Type To Choose
|
||||
|
||||
| Goal | Recommendation |
|
||||
| --- | --- |
|
||||
| AI should automatically know a capability | Add or modify a skill. |
|
||||
| User wants to trigger manually with a command | Add or modify a command/prompt/workflow. |
|
||||
| Team project conventions | Prefer `.trellis/spec/` or a project-local skill. |
|
||||
| Change Trellis flow semantics | Synchronize `.trellis/workflow.md`. |
|
||||
|
||||
## Modify A Skill
|
||||
|
||||
A skill is usually:
|
||||
|
||||
```text
|
||||
<skill-name>/
|
||||
├── SKILL.md
|
||||
└── references/
|
||||
```
|
||||
|
||||
`SKILL.md` should be short and responsible for triggering/routing. Put long content in `references/` so AI can read it on demand.
|
||||
|
||||
The frontmatter description should specify when to use the skill. Example:
|
||||
|
||||
```yaml
|
||||
description: "Use when customizing this project's deployment workflow and release checklist."
|
||||
```
|
||||
|
||||
Do not write vague descriptions such as "helpful project skill"; they can trigger incorrectly.
|
||||
|
||||
## Modify A Command/Prompt/Workflow
|
||||
|
||||
Explicit entry points should state:
|
||||
|
||||
- How the user triggers it.
|
||||
- Which `.trellis/` files to read.
|
||||
- Which scripts to run.
|
||||
- How to report after completion.
|
||||
|
||||
If a command only repeats workflow rules, prefer making it reference/read `.trellis/workflow.md` instead of maintaining a second copy of the flow.
|
||||
|
||||
## Common Paths
|
||||
|
||||
| Platform | Entry directories |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/`, `.claude/commands/` |
|
||||
| Cursor | `.cursor/skills/`, `.cursor/commands/` |
|
||||
| OpenCode | `.opencode/skills/`, `.opencode/commands/` |
|
||||
| Codex | `.agents/skills/`, `.codex/skills/` |
|
||||
| GitHub Copilot | `.github/skills/`, `.github/prompts/` |
|
||||
| Kilo / Antigravity / Windsurf | workflows + skills |
|
||||
|
||||
## Add A Project-Local Skill
|
||||
|
||||
If the user wants to document team-private customizations, create a project-local skill, for example:
|
||||
|
||||
```text
|
||||
.claude/skills/project-trellis-local/
|
||||
└── SKILL.md
|
||||
```
|
||||
|
||||
For multi-platform projects, add equivalent versions in each platform skill directory, or use `.agents/skills/` on platforms that support the shared layer.
|
||||
|
||||
## Notes
|
||||
|
||||
- Do not mix every platform's syntax into one file.
|
||||
- Do not change only one platform entry point while claiming all platforms are supported.
|
||||
- Do not hide long-term engineering conventions inside a command; write them to `.trellis/spec/`.
|
||||
@@ -0,0 +1,83 @@
|
||||
# Change Local Spec Structure
|
||||
|
||||
When the user wants to change the engineering conventions AI follows, add new spec layers, or adjust monorepo package mapping, edit `.trellis/spec/` and `.trellis/config.yaml`.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. `.trellis/config.yaml`
|
||||
2. `.trellis/spec/`
|
||||
3. `.trellis/workflow.md` Phase 1.3 and Phase 3.3
|
||||
4. Current task `implement.jsonl` / `check.jsonl`
|
||||
|
||||
## Common Needs
|
||||
|
||||
| Need | Edit location |
|
||||
| --- | --- |
|
||||
| Add backend/frontend/docs/test spec layer | `.trellis/spec/<layer>/` or `.trellis/spec/<package>/<layer>/` |
|
||||
| Add shared thinking guides | `.trellis/spec/guides/` |
|
||||
| Adjust monorepo packages | `packages` in `.trellis/config.yaml` |
|
||||
| Change default package | `default_package` in `.trellis/config.yaml` |
|
||||
| Control spec scanning scope | `spec_scope` in `.trellis/config.yaml` |
|
||||
| Make a task read a new spec | Task `implement.jsonl` / `check.jsonl` |
|
||||
|
||||
## Add A Spec Layer
|
||||
|
||||
Single-repository example:
|
||||
|
||||
```text
|
||||
.trellis/spec/security/
|
||||
├── index.md
|
||||
└── auth.md
|
||||
```
|
||||
|
||||
Monorepo example:
|
||||
|
||||
```text
|
||||
.trellis/spec/webapp/security/
|
||||
├── index.md
|
||||
└── auth.md
|
||||
```
|
||||
|
||||
`index.md` should include:
|
||||
|
||||
- What code this layer applies to.
|
||||
- Pre-Development Checklist.
|
||||
- Quality Check.
|
||||
- Links to specific guideline files.
|
||||
|
||||
## Update Context
|
||||
|
||||
Adding a spec does not mean every task automatically reads it. The current task must reference it in JSONL:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py add-context <task> implement ".trellis/spec/webapp/security/index.md" "Security conventions"
|
||||
python3 ./.trellis/scripts/task.py add-context <task> check ".trellis/spec/webapp/security/index.md" "Security review rules"
|
||||
```
|
||||
|
||||
## Change Monorepo Packages
|
||||
|
||||
Example `.trellis/config.yaml`:
|
||||
|
||||
```yaml
|
||||
packages:
|
||||
webapp:
|
||||
path: apps/web
|
||||
api:
|
||||
path: apps/api
|
||||
default_package: webapp
|
||||
```
|
||||
|
||||
After editing, run:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode packages
|
||||
```
|
||||
|
||||
Use this output to confirm AI can see the correct packages and spec layers.
|
||||
|
||||
## Notes
|
||||
|
||||
- Specs are user project conventions and can be changed according to project needs.
|
||||
- Do not put temporary task information into specs; put temporary information in the task.
|
||||
- Do not put long-term conventions only in agents or commands; preserve them in specs.
|
||||
- After changing spec structure, check whether existing task JSONL files still point to files that exist.
|
||||
@@ -0,0 +1,90 @@
|
||||
# Change Local Task Lifecycle
|
||||
|
||||
Task lifecycle includes creation, start, context configuration, finish, archive, parent/child tasks, and lifecycle hooks. The default customization targets are `.trellis/tasks/`, `.trellis/config.yaml`, and `.trellis/scripts/`.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. `.trellis/workflow.md`
|
||||
2. `.trellis/config.yaml`
|
||||
3. `.trellis/scripts/task.py`
|
||||
4. `.trellis/scripts/common/task_store.py`
|
||||
5. `.trellis/scripts/common/task_utils.py`
|
||||
6. The current task's `.trellis/tasks/<task>/task.json`
|
||||
|
||||
## Common Needs And Edit Points
|
||||
|
||||
| Need | Edit point |
|
||||
| --- | --- |
|
||||
| Automatically sync an external system after task creation | `hooks.after_create` in `.trellis/config.yaml`. |
|
||||
| Automatically update status after task start | `hooks.after_start` in `.trellis/config.yaml`. |
|
||||
| Run a script after task finish | `hooks.after_finish` in `.trellis/config.yaml`. |
|
||||
| Clean external resources after archive | `hooks.after_archive` in `.trellis/config.yaml`. |
|
||||
| Change default task fields | `.trellis/scripts/common/task_store.py`. |
|
||||
| Change task parsing/search | `.trellis/scripts/common/task_utils.py`. |
|
||||
| Change active task behavior | `.trellis/scripts/common/active_task.py`. |
|
||||
|
||||
## lifecycle hooks
|
||||
|
||||
`.trellis/config.yaml` supports:
|
||||
|
||||
```yaml
|
||||
hooks:
|
||||
after_create:
|
||||
- "python3 .trellis/scripts/hooks/my_sync.py create"
|
||||
after_start:
|
||||
- "python3 .trellis/scripts/hooks/my_sync.py start"
|
||||
after_finish:
|
||||
- "python3 .trellis/scripts/hooks/my_sync.py finish"
|
||||
after_archive:
|
||||
- "python3 .trellis/scripts/hooks/my_sync.py archive"
|
||||
```
|
||||
|
||||
Hook commands receive the `TASK_JSON_PATH` environment variable, pointing to the current task's `task.json`. Hook failures should usually warn, but not block the main task operation.
|
||||
|
||||
## Change Task Fields
|
||||
|
||||
If the user wants to add project-local fields, prefer putting them under `meta` in `task.json` to avoid breaking existing scripts' assumptions about standard fields.
|
||||
|
||||
Example:
|
||||
|
||||
```json
|
||||
"meta": {
|
||||
"linearIssue": "ENG-123",
|
||||
"risk": "high"
|
||||
}
|
||||
```
|
||||
|
||||
If standard fields really need to change, inspect every local script that reads `task.json`.
|
||||
|
||||
## Change Active Task
|
||||
|
||||
Active task is session-level state stored in `.trellis/.runtime/sessions/`. Do not fall back to a global `.current-task` model. If the user wants to change active task behavior, edit:
|
||||
|
||||
- `.trellis/scripts/common/active_task.py`
|
||||
- platform hooks or shell session bridges
|
||||
- active task descriptions in `.trellis/workflow.md`
|
||||
|
||||
### `task.py create` Sets the Active Pointer
|
||||
|
||||
`cmd_create` in `.trellis/scripts/common/task_store.py` calls `set_active_task` best-effort right after writing the new task directory. The behavior:
|
||||
|
||||
- When the calling shell carries session identity (`TRELLIS_CONTEXT_ID` env var, or any platform-specific session env that `resolve_context_key` recognizes — see `active_task.py:_ENV_SESSION_KEYS`), the per-session pointer at `.trellis/.runtime/sessions/<context_key>.json` is rewritten to point at the new task. The task's `status=planning` and `[workflow-state:planning]` fires on the very next `UserPromptSubmit`.
|
||||
- When session identity is unavailable (raw CLI invocation outside an AI session, or a platform that doesn't propagate identity to shell), the task directory is still created and `status=planning` is still written, but the active pointer is left untouched. The user can attach the task later with `task.py start <dir>` once they're back in an AI session.
|
||||
|
||||
This makes `[workflow-state:planning]` the live breadcrumb during the brainstorm and JSONL curation work that follows `task.py create`. The pre-R7 behavior left the breadcrumb stuck on `no_task` until `task.py start`, so the planning block was effectively dead text.
|
||||
|
||||
If you fork `task.py` to add a new creation path (e.g. an external import that bypasses `cmd_create`), audit whether your path also calls `set_active_task`. Without that call, your created tasks will not surface as active. The full status writer table is in `.trellis/spec/cli/backend/workflow-state-contract.md`.
|
||||
|
||||
## Modification Steps
|
||||
|
||||
1. Confirm the current task with `python3 ./.trellis/scripts/task.py current --source`.
|
||||
2. Read the current task's `task.json` and confirm status and fields.
|
||||
3. For configuration needs, edit `.trellis/config.yaml` first.
|
||||
4. For script behavior needs, then edit `.trellis/scripts/`.
|
||||
5. If the AI flow changed, synchronize `.trellis/workflow.md`.
|
||||
|
||||
## Do Not
|
||||
|
||||
- Do not directly edit `.trellis/.runtime/sessions/` to "fix" business state.
|
||||
- Do not hard-code project-private fields into scripts; prefer `meta`.
|
||||
- Do not default to asking the user to fork Trellis CLI.
|
||||
@@ -0,0 +1,64 @@
|
||||
# Change Local Workflow
|
||||
|
||||
When the user wants to change Trellis phases, next-action hints, whether to create tasks, whether to use sub-agents, or when to check/wrap up, edit `.trellis/workflow.md` first.
|
||||
|
||||
## Read These Files First
|
||||
|
||||
1. `.trellis/workflow.md`
|
||||
2. Entry files for the current platform, such as skills/commands/prompts/workflows
|
||||
3. The current task's `task.json` and `prd.md`
|
||||
|
||||
## Common Needs And Edit Points
|
||||
|
||||
| Need | Edit point |
|
||||
| --- | --- |
|
||||
| Change phase names or phase order | `Phase Index` and the corresponding Phase sections. |
|
||||
| Change whether to create a task when there is no task | `[workflow-state:no_task]` state block. |
|
||||
| Change the next step during planning | Phase 1 and `[workflow-state:planning]`. |
|
||||
| Change whether an agent is required during in_progress | Phase 2 and `[workflow-state:in_progress]`. |
|
||||
| Change wrap-up after completion | Phase 3 and `[workflow-state:completed]`. |
|
||||
| Change which skill a user intent triggers | `Skill Routing` table. |
|
||||
|
||||
## Modification Steps
|
||||
|
||||
1. Find the relevant section in `.trellis/workflow.md`.
|
||||
2. When changing rules, keep explicit trigger conditions and next actions.
|
||||
3. If adding or renaming a skill/agent, synchronize the corresponding files in platform directories.
|
||||
4. Workflow-state changes only need an edit to the `[workflow-state:STATUS]` block in `.trellis/workflow.md`. The hook is parser-only — it reads whatever you put in the block. Keep the opening and closing tags' STATUS strings identical (`[workflow-state:foo]…[/workflow-state:foo]`); mismatched STATUS pairs are silently dropped.
|
||||
5. Make the AI reread `.trellis/workflow.md`; do not keep using rules from the old conversation.
|
||||
|
||||
## Example: Relax Task Creation Requirements
|
||||
|
||||
To change when task creation can be skipped, usually edit `[workflow-state:no_task]`:
|
||||
|
||||
```md
|
||||
[workflow-state:no_task]
|
||||
Task is not required when the answer is a one-reply explanation, no files are changed, and no research is needed.
|
||||
[/workflow-state:no_task]
|
||||
```
|
||||
|
||||
If the formal Phase 1 flow also needs to change, synchronize the Phase 1 section.
|
||||
|
||||
## Example: One Platform Does Not Use Sub-Agents
|
||||
|
||||
If the user wants only one platform to avoid sub-agents, first confirm whether that platform has a separate group in the workflow. Then change Phase 2 routing for that platform group instead of deleting all `trellis-implement` / `trellis-check` instructions across platforms.
|
||||
|
||||
## `/trellis:continue` Route Table
|
||||
|
||||
`/trellis:continue` resumes a task by deciding which phase step to load next. The decision combines `task.json.status` with the presence of artifacts inside the task directory. The mapping is fixed in the command itself; forks that add custom statuses must extend both the workflow.md tag block and this table.
|
||||
|
||||
| `status` | Artifact state | Resume at |
|
||||
| --- | --- | --- |
|
||||
| `planning` | `prd.md` missing | Phase 1.1 (load `trellis-brainstorm`) |
|
||||
| `planning` | `prd.md` exists, `implement.jsonl` only has the seed `_example` row | Phase 1.3 (curate JSONL context) |
|
||||
| `planning` | `prd.md` exists, `implement.jsonl` curated | Phase 1.4 (run `task.py start`) |
|
||||
| `in_progress` | no implementation in conversation history | Phase 2.1 (`trellis-implement`) |
|
||||
| `in_progress` | implementation done, no `trellis-check` run | Phase 2.2 (`trellis-check`) |
|
||||
| `in_progress` | check passed | Phase 3.1 (verify quality + spec update) |
|
||||
| `completed` | task is still in active tree | Phase 3.5 (run `/trellis:finish-work` to archive) |
|
||||
|
||||
When you add a custom status (e.g. `in-review`), add a `[workflow-state:in-review]` block in `.trellis/workflow.md` for the per-turn breadcrumb AND extend this route table — usually by editing the `/trellis:continue` command file (`.{platform}/commands/trellis/continue.md` or equivalent) to add a row that decides where to resume from. Without the route entry, `/trellis:continue` will fall through to a default branch and the user will not land on the step you intended.
|
||||
|
||||
## Notes
|
||||
|
||||
`.trellis/workflow.md` is the local project workflow, not an immutable template. The user can adapt it to team habits. After editing it, platform entry files may still contain old descriptions, so inspect them too.
|
||||
@@ -0,0 +1,55 @@
|
||||
# Local Customization Overview
|
||||
|
||||
This directory is for local AI working in a user project where Trellis was installed through npm and `trellis init` has already been run. The AI should modify generated `.trellis/` and platform directories inside the project, not Trellis CLI upstream source code.
|
||||
|
||||
## First Determine What The User Actually Wants To Change
|
||||
|
||||
| User wording | Read first |
|
||||
| --- | --- |
|
||||
| "Change the Trellis flow / phases / next prompt" | `change-workflow.md` |
|
||||
| "Change task creation, status, archive, or hooks" | `change-task-lifecycle.md` |
|
||||
| "AI did not read context / change injected content" | `change-context-loading.md` |
|
||||
| "A platform hook is not behaving as expected" | `change-hooks.md` |
|
||||
| "Change implement/check/research agent behavior" | `change-agents.md` |
|
||||
| "Add a skill/command/workflow/prompt" | `change-skills-or-commands.md` |
|
||||
| "Adjust the project spec structure" | `change-spec-structure.md` |
|
||||
| "Add team conventions and local notes" | `add-project-local-conventions.md` |
|
||||
|
||||
## General Operation Order
|
||||
|
||||
1. **Confirm platform and directories**: inspect which directories exist, such as `.claude/`, `.codex/`, `.cursor/`.
|
||||
2. **Confirm the current active task**: run `python3 ./.trellis/scripts/task.py current --source`.
|
||||
3. **Read the local source of truth**: prefer `.trellis/workflow.md`, `.trellis/config.yaml`, and relevant platform files.
|
||||
4. **Modify narrowly**: edit only files related to the user's request.
|
||||
5. **Synchronize semantics**: if a shared flow changes, check whether platform entry points also need changes; if a platform entry changes, check whether `.trellis/workflow.md` still agrees.
|
||||
|
||||
## Local File Priority
|
||||
|
||||
| Layer | Files |
|
||||
| --- | --- |
|
||||
| Workflow | `.trellis/workflow.md` |
|
||||
| Project configuration | `.trellis/config.yaml` |
|
||||
| Task material | `.trellis/tasks/<task>/` |
|
||||
| Project specs | `.trellis/spec/` |
|
||||
| Runtime scripts | `.trellis/scripts/` |
|
||||
| Platform integration | `.claude/`, `.codex/`, `.cursor/`, `.opencode/`, and similar directories |
|
||||
| Shared skill | `.agents/skills/` |
|
||||
|
||||
## Things Not To Do By Default
|
||||
|
||||
- Do not edit the global npm install directory.
|
||||
- Do not edit `node_modules/@mindfoldhq/trellis`.
|
||||
- Do not assume the user has the Trellis GitHub repository.
|
||||
- Do not overwrite local files already modified by the user with default templates.
|
||||
- Do not put team project rules into public `trellis-meta`; project rules belong in `.trellis/spec/` or a local skill.
|
||||
|
||||
## When To Inspect Upstream Source
|
||||
|
||||
Switch to an upstream source-code perspective only when the user explicitly expresses one of these goals:
|
||||
|
||||
- "I want to open a PR to Trellis"
|
||||
- "I want to change npm package publish contents"
|
||||
- "I want to fork Trellis"
|
||||
- "I want to modify the generation logic for `trellis init/update`"
|
||||
|
||||
Otherwise, default to modifying local Trellis files inside the user project.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Local Context Injection System
|
||||
|
||||
Trellis context injection aims to make AI read the right files at the right time instead of relying on model memory. In a user project, injection is implemented by `.trellis/` scripts together with platform hooks, agents, and skills.
|
||||
|
||||
## Injected Context Types
|
||||
|
||||
| Type | Source | Purpose |
|
||||
| --- | --- | --- |
|
||||
| session context | `.trellis/scripts/get_context.py` | Current developer, git status, active task, active tasks, journal, packages. |
|
||||
| workflow context | `.trellis/workflow.md` | Current Trellis flow and next action. |
|
||||
| spec context | `.trellis/spec/` + task JSONL | Specs that must be followed during implementation/checking. |
|
||||
| task context | `.trellis/tasks/<task>/prd.md`, `info.md`, `research/` | Current task requirements, design, and research. |
|
||||
| platform context | Platform hooks/settings/agents | Lets different AI tools read the files above through their own mechanisms. |
|
||||
|
||||
## session-start
|
||||
|
||||
Platforms with session-start support inject a Trellis overview when a session starts, clears, compacts, or receives a similar event. Injected content usually includes:
|
||||
|
||||
- workflow summary.
|
||||
- current task status.
|
||||
- active tasks.
|
||||
- spec index paths.
|
||||
- developer identity and git status.
|
||||
|
||||
If the user feels the AI does not know the current task in a new session, first check whether the platform's session-start hook or equivalent mechanism is installed and running.
|
||||
|
||||
## workflow-state
|
||||
|
||||
workflow-state is a lightweight hint injected around each user turn. Based on current task status, it selects a block from `.trellis/workflow.md`, such as `no_task`, `planning`, `in_progress`, or `completed`.
|
||||
|
||||
If the user wants to change "what the AI should do next in a given state," edit the corresponding state block in `.trellis/workflow.md` first.
|
||||
|
||||
## sub-agent context
|
||||
|
||||
Implement and check agents need task context. Trellis has two loading modes:
|
||||
|
||||
1. **hook push**: a platform hook injects `prd.md` and the files referenced by `implement.jsonl` / `check.jsonl` before the agent starts.
|
||||
2. **agent pull**: the agent definition instructs the agent to read the active task, PRD, and JSONL context after startup.
|
||||
|
||||
In both modes, JSONL files in the task directory are the key interface.
|
||||
|
||||
## JSONL Reading Rules
|
||||
|
||||
`implement.jsonl` and `check.jsonl` contain one JSON object per line:
|
||||
|
||||
```jsonl
|
||||
{"file": ".trellis/spec/backend/index.md", "reason": "Backend rules"}
|
||||
```
|
||||
|
||||
Readers should skip seed rows without a `file` field. When configuring JSONL, the AI should include only spec/research files, not pre-register code files that will be modified.
|
||||
|
||||
## Active Task And Context Key
|
||||
|
||||
Active task state lives in `.trellis/.runtime/sessions/` and is isolated per session. Hooks try to resolve the context key from platform events, environment variables, transcript paths, or `TRELLIS_CONTEXT_ID`.
|
||||
|
||||
If shell commands cannot see the same context key, `task.py current --source` may report no active task. In that case, check whether the platform passes session identity into the shell instead of hand-writing a global current-task file.
|
||||
|
||||
## Local Customization Points
|
||||
|
||||
| Need | Edit location |
|
||||
| --- | --- |
|
||||
| Change session-start injected content | The platform's `session-start` hook or plugin file. |
|
||||
| Change per-turn workflow-state rules | `[workflow-state:STATUS]` block in `.trellis/workflow.md`. The platform workflow-state hook parses these blocks verbatim and embeds no fallback text. |
|
||||
| Change how sub-agents read context | Platform agent definitions, the `inject-subagent-context` hook, or agent preludes. |
|
||||
| Change JSONL validation/display | `.trellis/scripts/common/task_context.py`. |
|
||||
| Change active task resolution | `.trellis/scripts/common/active_task.py`. |
|
||||
|
||||
When modifying context injection, verify two things: new sessions can see the correct task, and sub-agents can see the correct PRD/spec/research.
|
||||
@@ -0,0 +1,80 @@
|
||||
# Local Files Generated After Init
|
||||
|
||||
`trellis init` writes the Trellis runtime into the user project. Later, `trellis update` tries to update Trellis-managed template files, but it uses `.trellis/.template-hashes.json` to determine which files have already been modified by the user.
|
||||
|
||||
This page only describes files that are visible and editable inside the user project.
|
||||
|
||||
## `.trellis/`
|
||||
|
||||
```text
|
||||
.trellis/
|
||||
├── workflow.md
|
||||
├── config.yaml
|
||||
├── .developer
|
||||
├── .version
|
||||
├── .template-hashes.json
|
||||
├── .runtime/
|
||||
├── scripts/
|
||||
├── spec/
|
||||
├── tasks/
|
||||
└── workspace/
|
||||
```
|
||||
|
||||
| Path | Usually editable? | Notes |
|
||||
| --- | --- | --- |
|
||||
| `.trellis/workflow.md` | Yes | Local workflow documentation and AI routing rules. |
|
||||
| `.trellis/config.yaml` | Yes | Project configuration, hooks, packages, journal line limits, and related settings. |
|
||||
| `.trellis/spec/` | Yes | Project specs, intended to be updated regularly by users and AI. |
|
||||
| `.trellis/tasks/` | Yes | Task material and research artifacts, maintained by the task workflow. |
|
||||
| `.trellis/workspace/` | Yes | Session records, usually written by `add_session.py`. |
|
||||
| `.trellis/scripts/` | Carefully | Local runtime. It can be customized, but only after understanding the call chain. |
|
||||
| `.trellis/.runtime/` | No | Runtime state, usually written automatically by hooks/scripts. |
|
||||
| `.trellis/.developer` | Carefully | Current developer identity. |
|
||||
| `.trellis/.version` | No | Trellis version record used by update/migration logic. |
|
||||
| `.trellis/.template-hashes.json` | No | Template hash record. Do not hand-write business rules here. |
|
||||
|
||||
## Platform Directories
|
||||
|
||||
Different platforms generate different directories. Common categories:
|
||||
|
||||
| Category | Example paths | Purpose |
|
||||
| --- | --- | --- |
|
||||
| hooks | `.claude/hooks/`, `.codex/hooks/`, `.cursor/hooks/` | Inject session context, workflow-state, and sub-agent context. |
|
||||
| settings | `.claude/settings.json`, `.codex/hooks.json`, `.qoder/settings.json` | Tell the platform when to run hooks or plugins. |
|
||||
| agents | `.claude/agents/`, `.codex/agents/`, `.kiro/agents/` | Define agents such as `trellis-research`, `trellis-implement`, and `trellis-check`. |
|
||||
| skills | `.claude/skills/`, `.agents/skills/`, `.qoder/skills/` | Skills that auto-trigger or can be read by AI. |
|
||||
| commands/prompts/workflows | `.cursor/commands/`, `.github/prompts/`, `.windsurf/workflows/` | Explicit user-invoked command or workflow entry points. |
|
||||
|
||||
When modifying a platform directory, also confirm whether `.trellis/workflow.md` still describes the same flow.
|
||||
|
||||
## Meaning Of Template Hashes
|
||||
|
||||
`.trellis/.template-hashes.json` records the content hash from the last time Trellis wrote a template file. `trellis update` uses it to distinguish three cases:
|
||||
|
||||
| Case | Update behavior |
|
||||
| --- | --- |
|
||||
| File was not modified by the user | It can be updated automatically. |
|
||||
| File was modified by the user | Prompt the user to overwrite, keep, or generate `.new`. |
|
||||
| File is no longer a current template | It may be deleted, renamed, or preserved according to migration rules. |
|
||||
|
||||
When an AI customizes local Trellis files, it does not need to maintain hashes manually. It is normal for Trellis update to recognize the result as "modified by the user."
|
||||
|
||||
## Local Customization Boundaries
|
||||
|
||||
Editable by default:
|
||||
|
||||
- `.trellis/workflow.md`
|
||||
- `.trellis/config.yaml`
|
||||
- `.trellis/spec/**`
|
||||
- `.trellis/scripts/**`
|
||||
- Platform hooks, settings, agents, skills, commands, prompts, and workflows
|
||||
|
||||
Do not edit by default:
|
||||
|
||||
- Global npm install directory
|
||||
- `node_modules/@mindfoldhq/trellis`
|
||||
- Trellis GitHub repository source code
|
||||
- Concrete state files under `.trellis/.runtime/**`
|
||||
- Hash contents inside `.trellis/.template-hashes.json`
|
||||
|
||||
Switch to the Trellis CLI source-code perspective only when the user explicitly wants to contribute upstream.
|
||||
@@ -0,0 +1,51 @@
|
||||
# Local Trellis Architecture Overview
|
||||
|
||||
`trellis-meta` is for user projects that have already run `trellis init`. The user's machine usually has only the npm-installed `trellis` command plus the Trellis files generated inside the project; it may not have the Trellis CLI source code.
|
||||
|
||||
Therefore, when an AI uses this skill, the default customization target is local files inside the user project:
|
||||
|
||||
- `.trellis/`: workflow, tasks, specs, memory, scripts, and runtime state.
|
||||
- Platform directories: `.claude/`, `.codex/`, `.cursor/`, `.opencode/`, `.kiro/`, `.gemini/`, `.qoder/`, `.codebuddy/`, `.github/`, `.factory/`, `.pi/`, `.kilocode/`, `.agent/`, `.windsurf/`, and similar directories.
|
||||
- Shared skill layer: `.agents/skills/`.
|
||||
|
||||
Do not default to guiding the user to fork the Trellis CLI repository. Treat upstream source code as the operating target only when the user explicitly says they want to change Trellis upstream source, publish an npm package, or contribute a PR.
|
||||
|
||||
## Local System Model
|
||||
|
||||
Trellis provides three layers inside a user project:
|
||||
|
||||
1. **Workflow layer**: `.trellis/workflow.md` defines phases, routing, next actions, and prompt blocks.
|
||||
2. **Persistence layer**: `.trellis/tasks/`, `.trellis/spec/`, and `.trellis/workspace/` store tasks, specs, and session memory.
|
||||
3. **Platform integration layer**: hooks, settings, agents, skills, commands, prompts, and workflows in platform directories connect the Trellis workflow to different AI tools.
|
||||
|
||||
All three layers live inside the user project, so an AI can read and modify them directly.
|
||||
|
||||
## Core Paths
|
||||
|
||||
| Path | Purpose |
|
||||
| --- | --- |
|
||||
| `.trellis/workflow.md` | Workflow phases, skill routing, and workflow-state prompt blocks. |
|
||||
| `.trellis/config.yaml` | Project configuration, task lifecycle hooks, monorepo package configuration, and journal configuration. |
|
||||
| `.trellis/spec/` | The user's project-specific coding conventions and thinking guides. |
|
||||
| `.trellis/tasks/` | Each task's PRD, technical notes, research files, and JSONL context. |
|
||||
| `.trellis/workspace/` | Per-developer journals and cross-session memory. |
|
||||
| `.trellis/scripts/` | Local Python runtime used by commands, hooks, and context injection. |
|
||||
| `.trellis/.runtime/` | Session-level runtime state, such as the current task pointer. |
|
||||
| `.trellis/.template-hashes.json` | Template hashes for Trellis-managed files, used by update to determine whether local files were modified by the user. |
|
||||
|
||||
## AI Customization Principles
|
||||
|
||||
1. **Find the local source of truth first**: Do not edit from memory. Read `.trellis/workflow.md`, `.trellis/config.yaml`, the relevant platform directory, and related task files first.
|
||||
2. **Edit the user project, not the npm package cache**: Modify generated files inside the project, not `node_modules` or the global npm install directory.
|
||||
3. **Keep platform files aligned with `.trellis/`**: If workflow routing changes, also check whether platform skills or commands still describe the same flow.
|
||||
4. **Put project-specific rules in `.trellis/spec/` or a local skill**: Do not put team conventions into `trellis-meta`.
|
||||
5. **Preserve user changes**: If a file was already modified locally, work from the current content instead of overwriting it with a default template.
|
||||
|
||||
## How To Use This Directory
|
||||
|
||||
- To understand which files exist after init, read `generated-files.md`.
|
||||
- To change phases, routing, or next actions, read `workflow.md`.
|
||||
- To change the task model, JSONL context, or active task behavior, read `task-system.md`.
|
||||
- To change coding convention injection, read `spec-system.md`.
|
||||
- To understand journals and cross-session memory, read `workspace-memory.md`.
|
||||
- To change hooks or sub-agent context loading, read `context-injection.md`.
|
||||
@@ -0,0 +1,102 @@
|
||||
# Local Spec System
|
||||
|
||||
`.trellis/spec/` is the user's project-specific engineering spec library. Trellis is not about making AI memorize conventions; it injects relevant specs or requires the AI to read them at the right time.
|
||||
|
||||
## Directory Model
|
||||
|
||||
A common single-repository structure:
|
||||
|
||||
```text
|
||||
.trellis/spec/
|
||||
├── backend/
|
||||
│ ├── index.md
|
||||
│ └── ...
|
||||
├── frontend/
|
||||
│ ├── index.md
|
||||
│ └── ...
|
||||
└── guides/
|
||||
├── index.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
A common monorepo structure:
|
||||
|
||||
```text
|
||||
.trellis/spec/
|
||||
├── cli/
|
||||
│ ├── backend/
|
||||
│ │ ├── index.md
|
||||
│ │ └── ...
|
||||
│ └── unit-test/
|
||||
│ ├── index.md
|
||||
│ └── ...
|
||||
├── docs-site/
|
||||
│ └── docs/
|
||||
│ ├── index.md
|
||||
│ └── ...
|
||||
└── guides/
|
||||
├── index.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
`index.md` is the entry point for each layer. It should list the Pre-Development Checklist and Quality Check. Specific guidelines live in other Markdown files in the same directory.
|
||||
|
||||
## Package Configuration
|
||||
|
||||
`.trellis/config.yaml` can declare packages:
|
||||
|
||||
```yaml
|
||||
packages:
|
||||
cli:
|
||||
path: packages/cli
|
||||
docs-site:
|
||||
path: docs-site
|
||||
type: submodule
|
||||
default_package: cli
|
||||
```
|
||||
|
||||
The AI can run:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/get_context.py --mode packages
|
||||
```
|
||||
|
||||
This command lists packages and spec layers for the current project. Use this output as the reference when configuring context JSONL.
|
||||
|
||||
## How Specs Enter Tasks
|
||||
|
||||
Before a task enters implementation, Phase 1.3 should write relevant specs into `implement.jsonl` / `check.jsonl`:
|
||||
|
||||
```jsonl
|
||||
{"file": ".trellis/spec/cli/backend/index.md", "reason": "CLI backend conventions"}
|
||||
{"file": ".trellis/spec/cli/unit-test/conventions.md", "reason": "Test expectations"}
|
||||
```
|
||||
|
||||
Sub-agents or platform preludes read these JSONL files and load the referenced specs. On platforms without sub-agent support, the AI should read the relevant specs directly according to the workflow.
|
||||
|
||||
## What Specs Should Contain
|
||||
|
||||
Specs should contain executable engineering conventions for the project, not generic best practices:
|
||||
|
||||
- Where files should live.
|
||||
- How error handling should be expressed.
|
||||
- Input/output contracts for APIs, hooks, and commands.
|
||||
- Patterns that are forbidden.
|
||||
- Cases that require tests.
|
||||
- Project-specific pitfalls and how to avoid them.
|
||||
|
||||
When the AI learns a new rule during implementation or debugging, it should update `.trellis/spec/` rather than only summarizing it in chat.
|
||||
|
||||
## Local Customization Points
|
||||
|
||||
| Need | Edit location |
|
||||
| --- | --- |
|
||||
| Add a new spec layer | `.trellis/spec/<package>/<layer>/index.md` and corresponding guideline files. |
|
||||
| Change monorepo spec mapping | `packages` / `default_package` / `spec_scope` in `.trellis/config.yaml`. |
|
||||
| Change which specs AI reads before implementation | The task's `implement.jsonl`. |
|
||||
| Change which specs AI reads during checking | The task's `check.jsonl`. |
|
||||
| Change when specs should be updated | Phase 3.3 in `.trellis/workflow.md` and the `trellis-update-spec` skill. |
|
||||
|
||||
## Boundaries
|
||||
|
||||
`.trellis/spec/` is the user's project specification, not a permanent copy of Trellis built-in templates. The AI should encourage the user to update it according to the actual project code instead of treating Trellis default templates as immutable documents.
|
||||
@@ -0,0 +1,101 @@
|
||||
# Local Task System
|
||||
|
||||
The Trellis task system is stored entirely under `.trellis/tasks/` in the user project. Each task is a directory containing requirements, context, research, state, and relationship information.
|
||||
|
||||
## Task Directory Structure
|
||||
|
||||
```text
|
||||
.trellis/tasks/
|
||||
├── 04-28-example-task/
|
||||
│ ├── task.json
|
||||
│ ├── prd.md
|
||||
│ ├── info.md
|
||||
│ ├── implement.jsonl
|
||||
│ ├── check.jsonl
|
||||
│ └── research/
|
||||
└── archive/
|
||||
└── 2026-04/
|
||||
```
|
||||
|
||||
| File | Purpose |
|
||||
| --- | --- |
|
||||
| `task.json` | Task metadata: status, assignee, priority, branch, parent/child tasks, and similar fields. |
|
||||
| `prd.md` | Requirements document; the most important business context during implementation. |
|
||||
| `info.md` | Optional technical design. |
|
||||
| `implement.jsonl` | List of spec/research files the implement agent must read first. |
|
||||
| `check.jsonl` | List of spec/research files the check agent must read first. |
|
||||
| `research/` | Research artifacts. Complex findings should not live only in chat. |
|
||||
|
||||
## `task.json`
|
||||
|
||||
`task.json` records task status and metadata. Common fields:
|
||||
|
||||
| Field | Meaning |
|
||||
| --- | --- |
|
||||
| `id` / `name` / `title` | Task identity and title. |
|
||||
| `status` | Status such as `planning`, `in_progress`, `review`, or `completed`. |
|
||||
| `priority` | `P0`, `P1`, `P2`, `P3`. |
|
||||
| `creator` / `assignee` | Creator and assignee. |
|
||||
| `package` | Target package in a monorepo; may be empty. |
|
||||
| `branch` / `base_branch` | Working branch and PR target branch. |
|
||||
| `children` / `parent` | Parent/child task relationships. |
|
||||
| `commit` / `pr_url` | Commit and PR information after completion. |
|
||||
| `meta` | Extension fields. |
|
||||
|
||||
The AI should not treat phase numbers as task status. Task progress is mainly determined by `status`, `prd.md`, whether JSONL context is configured, and the phase descriptions in `workflow.md`.
|
||||
|
||||
## Active Task
|
||||
|
||||
The user sees a "current task," but Trellis stores active task state per session.
|
||||
|
||||
```text
|
||||
.trellis/.runtime/sessions/<context-key>.json
|
||||
```
|
||||
|
||||
`task.py start` writes the task path into the runtime session file for the current session. `task.py current --source` shows the current task and where it came from. Different AI windows can point to different tasks without overwriting each other.
|
||||
|
||||
If the platform or shell environment has no stable session identity, `task.py start` may be unable to set the active task. The AI should read the error, inspect the platform hook/session environment, and not fall back to a shared global pointer.
|
||||
|
||||
## JSONL Context
|
||||
|
||||
`implement.jsonl` and `check.jsonl` are context manifests for sub-agents to read first.
|
||||
|
||||
Format:
|
||||
|
||||
```jsonl
|
||||
{"file": ".trellis/spec/cli/backend/index.md", "reason": "Backend conventions"}
|
||||
{"file": ".trellis/tasks/04-28-example/research/api.md", "reason": "API research"}
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- Include spec and research files.
|
||||
- Do not include code files that are about to be modified.
|
||||
- Do not treat temporary conclusions in chat as the only context.
|
||||
- Seed rows have no `file` field; they only prompt the AI to fill in real entries.
|
||||
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py create "<title>" --slug <slug>
|
||||
python3 ./.trellis/scripts/task.py start <task>
|
||||
python3 ./.trellis/scripts/task.py current --source
|
||||
python3 ./.trellis/scripts/task.py add-context <task> implement <file> <reason>
|
||||
python3 ./.trellis/scripts/task.py validate <task>
|
||||
python3 ./.trellis/scripts/task.py finish
|
||||
python3 ./.trellis/scripts/task.py archive <task>
|
||||
```
|
||||
|
||||
When modifying the task system, the AI should prefer script commands to maintain structure. Edit JSON/Markdown directly only when scripts do not cover the need.
|
||||
|
||||
## Local Customization Points
|
||||
|
||||
| Need | Edit location |
|
||||
| --- | --- |
|
||||
| Change the default task template | `.trellis/scripts/common/task_store.py` and task creation instructions. |
|
||||
| Change status semantics | `.trellis/workflow.md`, workflow-state hook logic, and task usage conventions. |
|
||||
| Add task lifecycle actions | `hooks.after_*` in `.trellis/config.yaml`. |
|
||||
| Change context rules | Phase 1.3 in `.trellis/workflow.md` and related platform agent/hook instructions. |
|
||||
| Change archive policy | `.trellis/scripts/common/task_store.py` / `task_utils.py`. |
|
||||
|
||||
These are local files in the user project. Do not default to editing Trellis CLI source code unless the user wants to contribute upstream.
|
||||
@@ -0,0 +1,75 @@
|
||||
# Local Workflow System
|
||||
|
||||
`.trellis/workflow.md` is the Trellis workflow source of truth inside the user project. An AI does not need Trellis source code to understand how the current project should move tasks forward; this file is enough.
|
||||
|
||||
## File Responsibilities
|
||||
|
||||
`.trellis/workflow.md` has three responsibilities:
|
||||
|
||||
1. **Explain workflow phases**: Plan, Execute, Finish.
|
||||
2. **Define skill routing**: which skill or agent the AI should use when the user expresses a certain intent.
|
||||
3. **Provide workflow-state prompt blocks**: hooks can inject the prompt block for the current state into the conversation.
|
||||
|
||||
## Current Phase Model
|
||||
|
||||
```text
|
||||
Phase 1: Plan -> clarify what to build, produce prd.md and required research
|
||||
Phase 2: Execute -> implement against the PRD and specs, then check
|
||||
Phase 3: Finish -> final verification, preserve lessons, and wrap up
|
||||
```
|
||||
|
||||
Each phase contains numbered steps, such as `1.3 Configure context`. These numbers are not runtime fields in `task.json`; they are workflow structure for AI and humans to read.
|
||||
|
||||
## Skill Routing
|
||||
|
||||
`workflow.md` separates routing by platform capability:
|
||||
|
||||
- Platforms with sub-agent support: dispatch `trellis-implement` by default for implementation and `trellis-check` for checking.
|
||||
- Platforms without sub-agent support: the main session reads skills such as `trellis-before-dev`, then executes directly.
|
||||
|
||||
When changing local AI behavior, update the routing descriptions in `workflow.md` first, then check whether the corresponding platform skill, command, or agent files need to stay in sync.
|
||||
|
||||
## Workflow-State Prompt Blocks
|
||||
|
||||
The bottom of `workflow.md` can contain state blocks like this:
|
||||
|
||||
```text
|
||||
[workflow-state:no_task]
|
||||
...
|
||||
[/workflow-state:no_task]
|
||||
```
|
||||
|
||||
Hooks choose the right block based on current task status and inject it into the conversation. Common states include:
|
||||
|
||||
| State | Meaning |
|
||||
| --- | --- |
|
||||
| `no_task` | The current session has no active task. |
|
||||
| `planning` | The task is still in requirements, research, or context configuration. |
|
||||
| `in_progress` | The task has entered implementation and checking. |
|
||||
| `completed` | The task is complete and waiting for wrap-up or archive. |
|
||||
|
||||
If the user wants to change policies such as "whether to create a task when there is no task," "when task creation may be skipped," or "whether sub-agents are required," edit these state blocks and the routing table above them.
|
||||
|
||||
## Local Modification Patterns
|
||||
|
||||
Common changes:
|
||||
|
||||
| Goal | Edit point |
|
||||
| --- | --- |
|
||||
| Add a phase | Update the Phase Index, phase body, routing, and state blocks. |
|
||||
| Change task creation policy | Update the `no_task` state block and Phase 1 description. |
|
||||
| Change the default implementation/check path | Update Phase 2 and skill routing. |
|
||||
| Change the wrap-up flow | Update Phase 3 and `finish-work` related descriptions. Note the current split: Phase 3.4 = AI-driven code commits (batched, user-confirmed), Phase 3.5 = `/finish-work` (archive + record session). `/finish-work` refuses to run if the working tree is dirty. |
|
||||
| Change platform differences | Update routing descriptions grouped by platform. |
|
||||
|
||||
After editing, make the AI reread `.trellis/workflow.md`; do not assume the flow from the old conversation is still valid.
|
||||
|
||||
## Relationship To Platform Files
|
||||
|
||||
`workflow.md` is the semantic center of the local workflow, but each platform can also have its own entry files:
|
||||
|
||||
- skills, such as `trellis-brainstorm` and `trellis-check`.
|
||||
- commands/prompts/workflows, such as continue and finish-work.
|
||||
- hooks, such as session-start or workflow-state injection.
|
||||
|
||||
If only `workflow.md` changes, platform entry files may still contain old language. When the user wants to change "what the AI actually does," also inspect the relevant platform directory.
|
||||
@@ -0,0 +1,71 @@
|
||||
# Local Workspace Memory System
|
||||
|
||||
`.trellis/workspace/` stores cross-session memory. Its purpose is to let AI and humans understand what happened before across different windows and different days.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```text
|
||||
.trellis/workspace/
|
||||
├── index.md
|
||||
└── <developer>/
|
||||
├── index.md
|
||||
├── journal-1.md
|
||||
└── journal-2.md
|
||||
```
|
||||
|
||||
| File | Purpose |
|
||||
| --- | --- |
|
||||
| `.trellis/.developer` | Current developer identity. |
|
||||
| `.trellis/workspace/index.md` | Global workspace overview. |
|
||||
| `.trellis/workspace/<developer>/index.md` | Session index for a developer. |
|
||||
| `.trellis/workspace/<developer>/journal-N.md` | Session journal. |
|
||||
|
||||
## Developer Identity
|
||||
|
||||
Run this the first time:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/init_developer.py <name>
|
||||
```
|
||||
|
||||
This creates `.trellis/.developer` and the corresponding workspace directory. The AI should not change developer identity casually; if the identity is wrong, first confirm who is using the current project.
|
||||
|
||||
## Journal
|
||||
|
||||
`journal-N.md` records completed or partially completed work from each session. By default, each journal holds about 2000 lines; after that it rotates to the next file.
|
||||
|
||||
Common command for recording a session:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/add_session.py \
|
||||
--title "Session title" \
|
||||
--summary "What changed" \
|
||||
--commit "abc1234"
|
||||
```
|
||||
|
||||
Planning or review work without a commit can also be recorded by using `--no-commit` or an empty commit value.
|
||||
|
||||
## Relationship Between Workspace Memory And Tasks
|
||||
|
||||
| System | What it stores |
|
||||
| --- | --- |
|
||||
| `.trellis/tasks/` | Requirements, design, research, and state for a specific task. |
|
||||
| `.trellis/workspace/` | Work records across tasks and sessions. |
|
||||
| `.trellis/spec/` | Engineering knowledge preserved as long-term conventions. |
|
||||
|
||||
If information is only useful for the current task, put it in the task directory.
|
||||
If information describes what happened in the current session, put it in the workspace journal.
|
||||
If information should be followed every time code is written in the future, put it in spec.
|
||||
|
||||
## Local Customization Points
|
||||
|
||||
| Need | Edit location |
|
||||
| --- | --- |
|
||||
| Change maximum journal lines | `max_journal_lines` in `.trellis/config.yaml`. |
|
||||
| Change session auto-commit message | `session_commit_message` in `.trellis/config.yaml`. |
|
||||
| Change session content format | `.trellis/scripts/add_session.py`. |
|
||||
| Change how workspace is displayed in context | `.trellis/scripts/common/session_context.py`. |
|
||||
|
||||
## AI Usage Rules
|
||||
|
||||
The AI should not treat workspace as the only source of truth. When resuming a task, read the current task first, then use workspace for background. After a task is complete, record important process notes in workspace; if long-term rules emerged, update spec.
|
||||
@@ -0,0 +1,79 @@
|
||||
# Agents
|
||||
|
||||
Trellis agent files define specialized roles. Common Trellis agents in a user project are:
|
||||
|
||||
- `trellis-research`
|
||||
- `trellis-implement`
|
||||
- `trellis-check`
|
||||
|
||||
File locations and formats differ by platform, but responsibility boundaries should stay consistent.
|
||||
|
||||
## Agent Responsibilities
|
||||
|
||||
| Agent | Responsibility |
|
||||
| --- | --- |
|
||||
| `trellis-research` | Investigate the question and write findings into the current task's `research/`. |
|
||||
| `trellis-implement` | Implement against `prd.md`, `info.md`, `implement.jsonl`, and related spec/research. |
|
||||
| `trellis-check` | Review changes, fix discovered issues, and run necessary checks. |
|
||||
|
||||
Agent files should not become generic chat prompts. They should define input sources, write boundaries, whether code may be changed, and how results are reported.
|
||||
|
||||
## Common Paths
|
||||
|
||||
| Platform | Agent path |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/agents/trellis-*.md` |
|
||||
| Cursor | `.cursor/agents/trellis-*.md` |
|
||||
| OpenCode | `.opencode/agents/trellis-*.md` |
|
||||
| Codex | `.codex/agents/trellis-*.toml` |
|
||||
| Kiro | `.kiro/agents/trellis-*.json` |
|
||||
| Gemini CLI | `.gemini/agents/trellis-*.md` |
|
||||
| Qoder | `.qoder/agents/trellis-*.md` |
|
||||
| CodeBuddy | `.codebuddy/agents/trellis-*.md` |
|
||||
| Factory Droid | `.factory/droids/trellis-*.md` |
|
||||
| Pi Agent | `.pi/agents/trellis-*.md` |
|
||||
|
||||
GitHub Copilot agent/prompt support is provided by a combination of directories such as `.github/agents/`, `.github/prompts/`, and `.github/skills/`; inspect the files actually generated in the user project.
|
||||
|
||||
Main-session workflow platforms such as Kilo, Antigravity, and Windsurf may not have Trellis sub-agent files. They usually rely on workflows/skills to guide the main session.
|
||||
|
||||
## Two Context Loading Modes
|
||||
|
||||
### hook push
|
||||
|
||||
The platform hook injects task context before the agent starts. The agent file itself can focus more on responsibilities and boundaries.
|
||||
|
||||
Common on platforms that support agent hooks.
|
||||
|
||||
### agent pull
|
||||
|
||||
The agent file instructs the agent to read after startup:
|
||||
|
||||
- `python3 ./.trellis/scripts/task.py current --source`
|
||||
- current task `prd.md`
|
||||
- `info.md`
|
||||
- `implement.jsonl` or `check.jsonl`
|
||||
- spec/research files referenced by JSONL
|
||||
|
||||
This mode fits platforms whose hooks cannot reliably rewrite sub-agent prompts.
|
||||
|
||||
## Local Change Scenarios
|
||||
|
||||
| User need | Edit location |
|
||||
| --- | --- |
|
||||
| Implement agent must follow extra restrictions | The platform's `trellis-implement` agent file. |
|
||||
| Check agent must run project-specific commands | `trellis-check` agent file, and `.trellis/spec/` if needed. |
|
||||
| Research agent must output a fixed format | `trellis-research` agent file. |
|
||||
| Agent cannot read task context | Agent prelude or `inject-subagent-context` hook. |
|
||||
| Add a project-specific agent | Platform agent directory + related workflow/command/skill entry point. |
|
||||
|
||||
## Modification Principles
|
||||
|
||||
1. **Keep responsibilities single-purpose**. Do not mix research, implement, and check responsibilities into one agent.
|
||||
2. **Specify the read order**. Agents must know to start from the active task and then find the PRD and JSONL.
|
||||
3. **Specify write boundaries**. Research usually only writes `research/`; implement can write code; check can fix issues.
|
||||
4. **Keep semantics synchronized in multi-platform projects**. If the user configured Claude, Codex, and Cursor together, decide whether changes to one platform's agent also need to be applied to others.
|
||||
|
||||
## Do Not Default To Editing Upstream Templates
|
||||
|
||||
Local AI should default to modifying platform agent files inside the user project. Discuss upstream template source only when the user explicitly wants to contribute the change back to Trellis.
|
||||
@@ -0,0 +1,69 @@
|
||||
# Hooks And Settings
|
||||
|
||||
Hooks/settings are the entry layer that connects a platform to Trellis. They decide which scripts, plugins, or extensions a platform runs for which events.
|
||||
|
||||
## Settings Responsibilities
|
||||
|
||||
settings/config files usually register:
|
||||
|
||||
- session-start hook: injects a Trellis overview when a new session starts or context resets.
|
||||
- workflow-state hook: parses `[workflow-state:STATUS]` blocks from `.trellis/workflow.md` and emits the body matching the current task `status` on each user input. Parser-only; the script does not embed fallback content.
|
||||
- sub-agent context hook: injects task context when implementation/check/research agents start.
|
||||
- shell/session bridge: lets shell commands see the same Trellis session identity.
|
||||
- platform plugin or extension entry points.
|
||||
|
||||
Common files:
|
||||
|
||||
| Platform | settings/config |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/settings.json` |
|
||||
| Cursor | `.cursor/hooks.json` |
|
||||
| Codex | `.codex/hooks.json`, `.codex/config.toml` |
|
||||
| OpenCode | `.opencode/package.json`, `.opencode/plugins/*` |
|
||||
| Kiro | `.kiro/hooks/` + platform config |
|
||||
| Gemini CLI | `.gemini/settings.json` |
|
||||
| Qoder | `.qoder/settings.json` |
|
||||
| CodeBuddy | `.codebuddy/settings.json` |
|
||||
| GitHub Copilot | `.github/copilot/hooks.json` |
|
||||
| Factory Droid | `.factory/settings.json` |
|
||||
| Pi Agent | `.pi/settings.json`, `.pi/extensions/trellis/` |
|
||||
|
||||
Whether these files exist in a project depends on which `trellis init --<platform>` flags the user ran.
|
||||
|
||||
## Hook Script Types
|
||||
|
||||
| Script | Purpose |
|
||||
| --- | --- |
|
||||
| `session-start.py` | Generates session-start context. |
|
||||
| `inject-workflow-state.py` | Parses `[workflow-state:STATUS]` blocks in `.trellis/workflow.md` and emits the body matching the current task status. Falls back to `Refer to workflow.md for current step.` when no matching block exists. |
|
||||
| `inject-subagent-context.py` | Injects PRD, JSONL context, and related spec/research into sub-agents. |
|
||||
| `inject-shell-session-context.py` | Lets shell commands inherit Trellis session identity. |
|
||||
|
||||
Not every platform has every hook. Do not copy files from another platform just because a platform lacks a hook; first confirm whether that platform supports the corresponding event.
|
||||
|
||||
## Local Change Scenarios
|
||||
|
||||
| User need | Edit location |
|
||||
| --- | --- |
|
||||
| AI should see more/less context in a new session | Platform `session-start` hook. |
|
||||
| Per-turn hint policy should change | `[workflow-state:STATUS]` block in `.trellis/workflow.md`. The hook parses workflow.md verbatim — no script edit required. |
|
||||
| Sub-agent cannot read PRD/spec | `inject-subagent-context` hook or agent prelude. |
|
||||
| `task.py current` in shell has no active task | Shell/session bridge hook or platform environment variable configuration. |
|
||||
| Disable an automatic injection | The corresponding hook registration in settings/config. |
|
||||
|
||||
## Modification Principles
|
||||
|
||||
1. **Settings wire things up; hooks define behavior**. If only the hook changes, the platform may never call it. If only settings change, behavior may not change.
|
||||
2. **Confirm platform event names first**. Different platforms use different names for SessionStart, UserPromptSubmit, AgentSpawn, shell execution, and similar events.
|
||||
3. **Hooks read local `.trellis/`, not upstream source**. `.trellis/scripts/` and `.trellis/workflow.md` in the user project are the default targets.
|
||||
4. **Errors must be visible**. Hook failures should tell the user what was not injected instead of silently leaving the AI without context.
|
||||
|
||||
## Troubleshooting Path
|
||||
|
||||
If the user says "AI did not read Trellis state":
|
||||
|
||||
1. Check whether the platform settings register the hook.
|
||||
2. Check whether the hook file exists.
|
||||
3. Manually run the `.trellis/scripts/get_context.py` or `task.py current --source` command that the hook depends on.
|
||||
4. Check whether active task state exists in `.trellis/.runtime/sessions/`.
|
||||
5. Check whether the platform shell passes session identity.
|
||||
@@ -0,0 +1,59 @@
|
||||
# Platform Files Overview
|
||||
|
||||
Trellis connects the same local architecture to different AI tools. `.trellis/` stores the shared runtime; platform directories store adapter files that define how each AI tool enters Trellis.
|
||||
|
||||
When a local AI modifies Trellis, it should distinguish two file categories first:
|
||||
|
||||
- **Shared files**: `.trellis/workflow.md`, `.trellis/tasks/`, `.trellis/spec/`, `.trellis/scripts/`.
|
||||
- **Platform files**: `.claude/`, `.codex/`, `.cursor/`, `.opencode/`, `.kiro/`, `.gemini/`, `.qoder/`, `.codebuddy/`, `.github/`, `.factory/`, `.pi/`, `.kilocode/`, `.agent/`, `.windsurf/`, and similar directories.
|
||||
|
||||
Platform files do not store business state. They let the corresponding AI tool read Trellis state, call Trellis scripts, and load Trellis skills/agents/hooks.
|
||||
|
||||
## Platform File Categories
|
||||
|
||||
| Category | Common paths | Purpose |
|
||||
| --- | --- | --- |
|
||||
| settings/config | `.claude/settings.json`, `.codex/hooks.json`, `.qoder/settings.json` | Register hooks, plugins, extensions, or platform behavior. |
|
||||
| hooks/plugins/extensions | `.claude/hooks/`, `.opencode/plugins/`, `.pi/extensions/` | Inject context at session start, user input, agent startup, shell execution, and similar events. |
|
||||
| agents | `.claude/agents/`, `.codex/agents/`, `.kiro/agents/` | Define `trellis-research`, `trellis-implement`, and `trellis-check`. |
|
||||
| skills | `.claude/skills/`, `.agents/skills/`, `.qoder/skills/` | Capability descriptions that auto-trigger or can be read on demand. |
|
||||
| commands/prompts/workflows | `.cursor/commands/`, `.github/prompts/`, `.windsurf/workflows/` | Entry points explicitly invoked by the user. |
|
||||
|
||||
## Three Platform Integration Modes
|
||||
|
||||
### 1. Hook / Extension Driven
|
||||
|
||||
These platforms can trigger scripts or plugins on specific events and actively inject Trellis context into AI.
|
||||
|
||||
Common capabilities:
|
||||
|
||||
- session-start injection of a `.trellis/` overview.
|
||||
- workflow-state hints for each user turn.
|
||||
- PRD/spec/research injection when sub-agents start.
|
||||
- Shell commands inheriting session identity.
|
||||
|
||||
To change "when the AI knows what," inspect hooks/plugins/extensions and settings first.
|
||||
|
||||
### 2. Agent Prelude / Pull-Based
|
||||
|
||||
Some platforms cannot reliably let hooks rewrite sub-agent prompts, so the agent file itself instructs the agent to read the active task, PRD, and JSONL context after startup.
|
||||
|
||||
To change how sub-agents load context, inspect the agent files themselves.
|
||||
|
||||
### 3. Main-Session Workflow
|
||||
|
||||
Some platforms do not have Trellis sub-agent or hook capabilities. They rely on workflows/skills/commands to guide the main-session AI to read files, run scripts, and move tasks forward.
|
||||
|
||||
To change behavior, inspect platform workflows/skills/commands and `.trellis/workflow.md`.
|
||||
|
||||
## Local Modification Order
|
||||
|
||||
When the user asks to customize behavior for a platform, the AI should inspect files in this order:
|
||||
|
||||
1. Read `.trellis/workflow.md` to confirm the shared flow.
|
||||
2. Read the target platform's settings/config to see which hooks/agents/skills/commands are registered.
|
||||
3. Read the target platform's agents/skills/commands/hooks.
|
||||
4. Modify the local file closest to the user's need.
|
||||
5. If the change affects the shared flow, synchronize `.trellis/workflow.md` or `.trellis/spec/`.
|
||||
|
||||
Do not modify only platform files and forget the shared workflow. Do not modify only `.trellis/workflow.md` and forget that platform entry points may still contain old descriptions.
|
||||
@@ -0,0 +1,74 @@
|
||||
# Platform File Map
|
||||
|
||||
This page lists common Trellis file locations in a user project by platform. Whether a platform directory exists in an actual project depends on which `trellis init --<platform>` commands the user ran.
|
||||
|
||||
## Matrix
|
||||
|
||||
| Platform | CLI flag | Main directory | Skill directory | Agent directory | Hooks/extensions |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| Claude Code | `--claude` | `.claude/` | `.claude/skills/` | `.claude/agents/` | `.claude/hooks/` + `.claude/settings.json` |
|
||||
| Cursor | `--cursor` | `.cursor/` | `.cursor/skills/` | `.cursor/agents/` | `.cursor/hooks.json` + `.cursor/hooks/` |
|
||||
| OpenCode | `--opencode` | `.opencode/` | `.opencode/skills/` | `.opencode/agents/` | `.opencode/plugins/` |
|
||||
| Codex | `--codex` | `.codex/` | `.agents/skills/` | `.codex/agents/` | `.codex/hooks/` + `.codex/hooks.json` |
|
||||
| Kilo | `--kilo` | `.kilocode/` | `.kilocode/skills/` | Usually none | `.kilocode/workflows/` |
|
||||
| Kiro | `--kiro` | `.kiro/` | `.kiro/skills/` | `.kiro/agents/` | `.kiro/hooks/` |
|
||||
| Gemini CLI | `--gemini` | `.gemini/` | `.agents/skills/` | `.gemini/agents/` | `.gemini/settings.json` + `.gemini/hooks/` |
|
||||
| Antigravity | `--antigravity` | `.agent/` | `.agent/skills/` | Usually none | `.agent/workflows/` |
|
||||
| Windsurf | `--windsurf` | `.windsurf/` | `.windsurf/skills/` | Usually none | `.windsurf/workflows/` |
|
||||
| Qoder | `--qoder` | `.qoder/` | `.qoder/skills/` | `.qoder/agents/` | `.qoder/hooks/` + `.qoder/settings.json` |
|
||||
| CodeBuddy | `--codebuddy` | `.codebuddy/` | `.codebuddy/skills/` | `.codebuddy/agents/` | `.codebuddy/hooks/` + `.codebuddy/settings.json` |
|
||||
| GitHub Copilot | `--copilot` | `.github/` | `.github/skills/` | `.github/agents/` | `.github/copilot/hooks/` + prompts |
|
||||
| Factory Droid | `--droid` | `.factory/` | `.factory/skills/` | `.factory/droids/` | `.factory/hooks/` + settings |
|
||||
| Pi Agent | `--pi` | `.pi/` | `.pi/skills/` | `.pi/agents/` | `.pi/extensions/trellis/` + `.pi/settings.json` |
|
||||
|
||||
## Capability Groups
|
||||
|
||||
### Trellis Sub-Agent Support
|
||||
|
||||
These platforms usually have `trellis-research`, `trellis-implement`, and `trellis-check` files:
|
||||
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- OpenCode
|
||||
- Codex
|
||||
- Kiro
|
||||
- Gemini CLI
|
||||
- Qoder
|
||||
- CodeBuddy
|
||||
- GitHub Copilot
|
||||
- Factory Droid
|
||||
- Pi Agent
|
||||
|
||||
When changing implementation/check/research behavior, look for the corresponding platform agent files first.
|
||||
|
||||
### Main-Session Workflow Platforms
|
||||
|
||||
These platforms rely more on workflows/skills to guide the main session:
|
||||
|
||||
- Kilo
|
||||
- Antigravity
|
||||
- Windsurf
|
||||
|
||||
When changing behavior, inspect workflows and skills first. Do not assume Trellis sub-agents exist.
|
||||
|
||||
### Shared `.agents/skills/`
|
||||
|
||||
Codex writes the shared `.agents/skills/` layer. Some tools that support agentskills.io can also read this directory. If the user wants multiple compatible tools to share one skill, consider `.agents/skills/` first, but do not assume every platform reads it.
|
||||
|
||||
## Decision Rules When Modifying Platform Files
|
||||
|
||||
1. User specified a platform: modify only that platform directory unless shared workflow/spec files must also change.
|
||||
2. User says "all platforms should do this": synchronize equivalent entry points platform by platform; do not modify only one directory.
|
||||
3. User only says "my AI": inspect the configuration directories that actually exist in the project and infer the current AI platform.
|
||||
4. User wants project rules: prefer `.trellis/spec/` or a project-local skill.
|
||||
5. User wants Trellis behavior: edit `.trellis/workflow.md` plus platform hooks/agents/skills/commands.
|
||||
|
||||
## When Paths Differ
|
||||
|
||||
Platform ecosystems change, and user projects may already be customized. If this table disagrees with local files, use the actual settings/config in the user project as authoritative:
|
||||
|
||||
- Check the hook that settings registers.
|
||||
- Check the script that a command/prompt/workflow points to.
|
||||
- Judge behavior by the read rules currently written in the agent file.
|
||||
|
||||
Do not delete a custom file just because it is not listed in this path table.
|
||||
@@ -0,0 +1,83 @@
|
||||
# Skills, Commands, Prompts, And Workflows
|
||||
|
||||
Skills and commands are textual entry points for user interaction with Trellis. Different platforms use different names, but their core purpose is the same: tell the AI how to enter the Trellis flow when the user expresses a certain intent.
|
||||
|
||||
## Conceptual Differences
|
||||
|
||||
| Type | Trigger mode | Best for |
|
||||
| --- | --- | --- |
|
||||
| skill | AI auto-match or explicit user mention | Long-term capabilities, workflow rules, modification guides. |
|
||||
| command | Explicit user invocation | Clear operation entry points such as continue and finish-work. |
|
||||
| prompt | Explicit user invocation or platform selection | Similar to command, but in a platform prompt format. |
|
||||
| workflow | Explicit user selection or platform auto-match | Guides the main session when no sub-agent/hook exists. |
|
||||
|
||||
Trellis workflow skills usually share one semantic set: brainstorm, before-dev, check, update-spec, break-loop. Multi-file built-in skills such as `trellis-meta` use layered references.
|
||||
|
||||
## Common Paths
|
||||
|
||||
| Platform | Common entries |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/`, `.claude/commands/` |
|
||||
| Cursor | `.cursor/skills/`, `.cursor/commands/` |
|
||||
| OpenCode | `.opencode/skills/`, `.opencode/commands/` |
|
||||
| Codex | `.agents/skills/`, `.codex/skills/` |
|
||||
| Kilo | `.kilocode/skills/`, `.kilocode/workflows/` |
|
||||
| Kiro | `.kiro/skills/` |
|
||||
| Gemini CLI | `.agents/skills/`, `.gemini/commands/` |
|
||||
| Antigravity | `.agent/skills/`, `.agent/workflows/` |
|
||||
| Windsurf | `.windsurf/skills/`, `.windsurf/workflows/` |
|
||||
| Qoder | `.qoder/skills/`, `.qoder/commands/` |
|
||||
| CodeBuddy | `.codebuddy/skills/`, `.codebuddy/commands/` |
|
||||
| GitHub Copilot | `.github/skills/`, `.github/prompts/` |
|
||||
| Factory Droid | `.factory/skills/`, `.factory/commands/` |
|
||||
| Pi Agent | `.pi/skills/` |
|
||||
|
||||
In a user project, use the files actually generated by init as authoritative.
|
||||
|
||||
## Skill Structure
|
||||
|
||||
A common skill is a directory:
|
||||
|
||||
```text
|
||||
trellis-meta/
|
||||
├── SKILL.md
|
||||
└── references/
|
||||
```
|
||||
|
||||
`SKILL.md` should tell the AI:
|
||||
|
||||
- When to use this skill.
|
||||
- Which reference to read first for the current task.
|
||||
- What not to do.
|
||||
|
||||
References hold longer explanations so the entry file does not contain everything.
|
||||
|
||||
## Command/Prompt/Workflow Structure
|
||||
|
||||
Commands, prompts, and workflows are usually single files. Their content should include:
|
||||
|
||||
- When to use it.
|
||||
- Which `.trellis/` files to read.
|
||||
- Which scripts to run.
|
||||
- How to report after completion.
|
||||
|
||||
They should not store task state; task state belongs in `.trellis/tasks/` and `.trellis/.runtime/`.
|
||||
|
||||
## Local Change Scenarios
|
||||
|
||||
| User need | Edit location |
|
||||
| --- | --- |
|
||||
| Change AI auto-trigger rules | The corresponding skill's frontmatter description. |
|
||||
| Change user command behavior | The corresponding command/prompt/workflow file. |
|
||||
| Add a project-local skill | Platform skill directory, or shared `.agents/skills/`. |
|
||||
| Let multiple platforms share one capability | Write equivalent skills in each platform skill directory, or use the `.agents/skills/` shared layer on platforms that support it. |
|
||||
| Change finish/continue entry points | Platform commands/prompts/workflows. |
|
||||
|
||||
## Modification Principles
|
||||
|
||||
1. **Keep entry files short; references carry long content**. This matters especially for multi-file skills like `trellis-meta`.
|
||||
2. **Make trigger descriptions specific**. A description that is too broad can mis-trigger; one that is too narrow may not trigger.
|
||||
3. **Keep the same semantics consistent across platforms**. File formats can differ, but behavior descriptions should match.
|
||||
4. **Put project-specific capabilities in local skills**. Do not put team-private flows into public `trellis-meta`.
|
||||
|
||||
If the user only wants local AI to know one more project rule, usually create a project-local skill or update `.trellis/spec/` instead of changing a Trellis built-in workflow skill.
|
||||
@@ -0,0 +1,356 @@
|
||||
---
|
||||
name: trellis-update-spec
|
||||
description: "Captures executable contracts and coding conventions into .trellis/spec/ documents. Use when learning something valuable from debugging, implementing, or discussion that should be preserved for future sessions."
|
||||
---
|
||||
|
||||
# Update Code-Spec - Capture Executable Contracts
|
||||
|
||||
When you learn something valuable (from debugging, implementing, or discussion), use this to update the relevant code-spec documents.
|
||||
|
||||
**Timing**: After completing a task, fixing a bug, or discovering a new pattern
|
||||
|
||||
---
|
||||
|
||||
## Code-Spec First Rule (CRITICAL)
|
||||
|
||||
In this project, "spec" for implementation work means **code-spec**:
|
||||
- Executable contracts (not principle-only text)
|
||||
- Concrete signatures, payload fields, env keys, and boundary behavior
|
||||
- Testable validation/error behavior
|
||||
|
||||
If the change touches infra or cross-layer contracts, code-spec depth is mandatory.
|
||||
|
||||
### Mandatory Triggers
|
||||
|
||||
Apply code-spec depth when the change includes any of:
|
||||
- New/changed command or API signature
|
||||
- Cross-layer request/response contract change
|
||||
- Database schema/migration change
|
||||
- Infra integration (storage, queue, cache, secrets, env wiring)
|
||||
|
||||
### Mandatory Output (7 Sections)
|
||||
|
||||
For triggered tasks, include all sections below:
|
||||
1. Scope / Trigger
|
||||
2. Signatures (command/API/DB)
|
||||
3. Contracts (request/response/env)
|
||||
4. Validation & Error Matrix
|
||||
5. Good/Base/Bad Cases
|
||||
6. Tests Required (with assertion points)
|
||||
7. Wrong vs Correct (at least one pair)
|
||||
|
||||
---
|
||||
|
||||
## When to Update Code-Specs
|
||||
|
||||
| Trigger | Example | Target Spec |
|
||||
|---------|---------|-------------|
|
||||
| **Implemented a feature** | Added a new integration or module | Relevant spec file |
|
||||
| **Made a design decision** | Chose extensibility pattern over simplicity | Relevant spec + "Design Decisions" section |
|
||||
| **Fixed a bug** | Found a subtle issue with error handling | Relevant spec (e.g., error-handling docs) |
|
||||
| **Discovered a pattern** | Found a better way to structure code | Relevant spec file |
|
||||
| **Hit a gotcha** | Learned that X must be done before Y | Relevant spec + "Common Mistakes" section |
|
||||
| **Established a convention** | Team agreed on naming pattern | Quality guidelines |
|
||||
| **New thinking trigger** | "Don't forget to check X before doing Y" | `guides/*.md` (as a checklist item) |
|
||||
|
||||
**Key Insight**: Code-spec updates are NOT just for problems. Every feature implementation contains design decisions and contracts that future AI/developers need to execute safely.
|
||||
|
||||
---
|
||||
|
||||
## Spec Structure Overview
|
||||
|
||||
```
|
||||
.trellis/spec/
|
||||
├── <layer>/ # Per-layer coding standards (e.g., backend/, frontend/, api/)
|
||||
│ ├── index.md # Overview and links
|
||||
│ └── *.md # Topic-specific guidelines
|
||||
└── guides/ # Thinking checklists (NOT coding specs!)
|
||||
├── index.md # Guide index
|
||||
└── *.md # Topic-specific guides
|
||||
```
|
||||
|
||||
### CRITICAL: Code-Spec vs Guide - Know the Difference
|
||||
|
||||
| Type | Location | Purpose | Content Style |
|
||||
|------|----------|---------|---------------|
|
||||
| **Code-Spec** | `<layer>/*.md` | Tell AI "how to implement safely" | Signatures, contracts, matrices, cases, test points |
|
||||
| **Guide** | `guides/*.md` | Help AI "what to think about" | Checklists, questions, pointers to specs |
|
||||
|
||||
**Decision Rule**: Ask yourself:
|
||||
|
||||
- "This is **how to write** the code" → Put in a spec layer directory
|
||||
- "This is **what to consider** before writing" → Put in `guides/`
|
||||
|
||||
**Example**:
|
||||
|
||||
| Learning | Wrong Location | Correct Location |
|
||||
|----------|----------------|------------------|
|
||||
| "Use API X not API Y for this task" | ❌ `guides/` (too specific for a thinking guide) | ✅ Relevant spec file (concrete convention) |
|
||||
| "Remember to check X when doing Y" | ❌ Spec file (too abstract for a spec) | ✅ `guides/` (thinking checklist) |
|
||||
|
||||
**Guides should be short checklists that point to specs**, not duplicate the detailed rules.
|
||||
|
||||
---
|
||||
|
||||
## Update Process
|
||||
|
||||
### Step 1: Identify What You Learned
|
||||
|
||||
Answer these questions:
|
||||
|
||||
1. **What did you learn?** (Be specific)
|
||||
2. **Why is it important?** (What problem does it prevent?)
|
||||
3. **Where does it belong?** (Which spec file?)
|
||||
|
||||
### Step 2: Classify the Update Type
|
||||
|
||||
| Type | Description | Action |
|
||||
|------|-------------|--------|
|
||||
| **Design Decision** | Why we chose approach X over Y | Add to "Design Decisions" section |
|
||||
| **Project Convention** | How we do X in this project | Add to relevant section with examples |
|
||||
| **New Pattern** | A reusable approach discovered | Add to "Patterns" section |
|
||||
| **Forbidden Pattern** | Something that causes problems | Add to "Anti-patterns" or "Don't" section |
|
||||
| **Common Mistake** | Easy-to-make error | Add to "Common Mistakes" section |
|
||||
| **Convention** | Agreed-upon standard | Add to relevant section |
|
||||
| **Gotcha** | Non-obvious behavior | Add warning callout |
|
||||
|
||||
### Step 3: Read the Target Code-Spec
|
||||
|
||||
Before editing, read the current code-spec to:
|
||||
- Understand existing structure
|
||||
- Avoid duplicating content
|
||||
- Find the right section for your update
|
||||
|
||||
```bash
|
||||
cat .trellis/spec/<category>/<file>.md
|
||||
```
|
||||
|
||||
### Step 4: Make the Update
|
||||
|
||||
Follow these principles:
|
||||
|
||||
1. **Be Specific**: Include concrete examples, not just abstract rules
|
||||
2. **Explain Why**: State the problem this prevents
|
||||
3. **Show Contracts**: Add signatures, payload fields, and error behavior
|
||||
4. **Show Code**: Add code snippets for key patterns
|
||||
5. **Keep it Short**: One concept per section
|
||||
|
||||
### Step 5: Update the Index (if needed)
|
||||
|
||||
If you added a new section or the code-spec status changed, update the category's `index.md`.
|
||||
|
||||
---
|
||||
|
||||
## Update Templates
|
||||
|
||||
### Mandatory Template for Infra/Cross-Layer Work
|
||||
|
||||
```markdown
|
||||
## Scenario: <name>
|
||||
|
||||
### 1. Scope / Trigger
|
||||
- Trigger: <why this requires code-spec depth>
|
||||
|
||||
### 2. Signatures
|
||||
- Backend command/API/DB signature(s)
|
||||
|
||||
### 3. Contracts
|
||||
- Request fields (name, type, constraints)
|
||||
- Response fields (name, type, constraints)
|
||||
- Environment keys (required/optional)
|
||||
|
||||
### 4. Validation & Error Matrix
|
||||
- <condition> -> <error>
|
||||
|
||||
### 5. Good/Base/Bad Cases
|
||||
- Good: ...
|
||||
- Base: ...
|
||||
- Bad: ...
|
||||
|
||||
### 6. Tests Required
|
||||
- Unit/Integration/E2E with assertion points
|
||||
|
||||
### 7. Wrong vs Correct
|
||||
#### Wrong
|
||||
...
|
||||
#### Correct
|
||||
...
|
||||
```
|
||||
|
||||
### Adding a Design Decision
|
||||
|
||||
```markdown
|
||||
### Design Decision: [Decision Name]
|
||||
|
||||
**Context**: What problem were we solving?
|
||||
|
||||
**Options Considered**:
|
||||
1. Option A - brief description
|
||||
2. Option B - brief description
|
||||
|
||||
**Decision**: We chose Option X because...
|
||||
|
||||
**Example**:
|
||||
\`\`\`typescript
|
||||
// How it's implemented
|
||||
code example
|
||||
\`\`\`
|
||||
|
||||
**Extensibility**: How to extend this in the future...
|
||||
```
|
||||
|
||||
### Adding a Project Convention
|
||||
|
||||
```markdown
|
||||
### Convention: [Convention Name]
|
||||
|
||||
**What**: Brief description of the convention.
|
||||
|
||||
**Why**: Why we do it this way in this project.
|
||||
|
||||
**Example**:
|
||||
\`\`\`typescript
|
||||
// How to follow this convention
|
||||
code example
|
||||
\`\`\`
|
||||
|
||||
**Related**: Links to related conventions or specs.
|
||||
```
|
||||
|
||||
### Adding a New Pattern
|
||||
|
||||
```markdown
|
||||
### Pattern Name
|
||||
|
||||
**Problem**: What problem does this solve?
|
||||
|
||||
**Solution**: Brief description of the approach.
|
||||
|
||||
**Example**:
|
||||
\`\`\`
|
||||
// Good
|
||||
code example
|
||||
|
||||
// Bad
|
||||
code example
|
||||
\`\`\`
|
||||
|
||||
**Why**: Explanation of why this works better.
|
||||
```
|
||||
|
||||
### Adding a Forbidden Pattern
|
||||
|
||||
```markdown
|
||||
### Don't: Pattern Name
|
||||
|
||||
**Problem**:
|
||||
\`\`\`
|
||||
// Don't do this
|
||||
bad code example
|
||||
\`\`\`
|
||||
|
||||
**Why it's bad**: Explanation of the issue.
|
||||
|
||||
**Instead**:
|
||||
\`\`\`
|
||||
// Do this instead
|
||||
good code example
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
### Adding a Common Mistake
|
||||
|
||||
```markdown
|
||||
### Common Mistake: Description
|
||||
|
||||
**Symptom**: What goes wrong
|
||||
|
||||
**Cause**: Why this happens
|
||||
|
||||
**Fix**: How to correct it
|
||||
|
||||
**Prevention**: How to avoid it in the future
|
||||
```
|
||||
|
||||
### Adding a Gotcha
|
||||
|
||||
```markdown
|
||||
> **Warning**: Brief description of the non-obvious behavior.
|
||||
>
|
||||
> Details about when this happens and how to handle it.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Interactive Mode
|
||||
|
||||
If you're unsure what to update, answer these prompts:
|
||||
|
||||
1. **What did you just finish?**
|
||||
- [ ] Fixed a bug
|
||||
- [ ] Implemented a feature
|
||||
- [ ] Refactored code
|
||||
- [ ] Had a discussion about approach
|
||||
|
||||
2. **What did you learn or decide?**
|
||||
- Design decision (why X over Y)
|
||||
- Project convention (how we do X)
|
||||
- Non-obvious behavior (gotcha)
|
||||
- Better approach (pattern)
|
||||
|
||||
3. **Would future AI/developers need to know this?**
|
||||
- To understand how the code works → Yes, update spec
|
||||
- To maintain or extend the feature → Yes, update spec
|
||||
- To avoid repeating mistakes → Yes, update spec
|
||||
- Purely one-off implementation detail → Maybe skip
|
||||
|
||||
4. **Which area does it relate to?**
|
||||
- [ ] Backend code
|
||||
- [ ] Frontend code
|
||||
- [ ] Cross-layer data flow
|
||||
- [ ] Code organization/reuse
|
||||
- [ ] Quality/testing
|
||||
|
||||
---
|
||||
|
||||
## Quality Checklist
|
||||
|
||||
Before finishing your code-spec update:
|
||||
|
||||
- [ ] Is the content specific and actionable?
|
||||
- [ ] Did you include a code example?
|
||||
- [ ] Did you explain WHY, not just WHAT?
|
||||
- [ ] Did you include executable signatures/contracts?
|
||||
- [ ] Did you include validation and error matrix?
|
||||
- [ ] Did you include Good/Base/Bad cases?
|
||||
- [ ] Did you include required tests with assertion points?
|
||||
- [ ] Is it in the right code-spec file?
|
||||
- [ ] Does it duplicate existing content?
|
||||
- [ ] Would a new team member understand it?
|
||||
|
||||
---
|
||||
|
||||
## Relationship to Other Commands
|
||||
|
||||
```
|
||||
Development Flow:
|
||||
Learn something → /trellis:update-spec → Knowledge captured
|
||||
↑ ↓
|
||||
/trellis:break-loop ←──────────────────── Future sessions benefit
|
||||
(deep bug analysis)
|
||||
```
|
||||
|
||||
- `/trellis:break-loop` - Analyzes bugs deeply, often reveals spec updates needed
|
||||
- `/trellis:update-spec` - Actually makes the updates
|
||||
- `/trellis:finish-work` - Reminds you to check if specs need updates
|
||||
|
||||
---
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
> **Code-specs are living documents. Every debugging session, every "aha moment" is an opportunity to make the implementation contract clearer.**
|
||||
|
||||
The goal is **institutional memory**:
|
||||
- What one person learns, everyone benefits from
|
||||
- What AI learns in one session, persists to future sessions
|
||||
- Mistakes become documented guardrails
|
||||
Reference in New Issue
Block a user