@mindfoldhq/trellis 0.3.10 → 0.4.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -5
- package/dist/cli/index.js +5 -0
- package/dist/cli/index.js.map +1 -1
- package/dist/commands/init.d.ts +4 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +240 -43
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +206 -47
- package/dist/commands/update.js.map +1 -1
- package/dist/configurators/codebuddy.d.ts +11 -0
- package/dist/configurators/codebuddy.d.ts.map +1 -0
- package/dist/configurators/codebuddy.js +58 -0
- package/dist/configurators/codebuddy.js.map +1 -0
- package/dist/configurators/codex.d.ts +7 -4
- package/dist/configurators/codex.d.ts.map +1 -1
- package/dist/configurators/codex.js +40 -10
- package/dist/configurators/codex.js.map +1 -1
- package/dist/configurators/copilot.d.ts +9 -0
- package/dist/configurators/copilot.d.ts.map +1 -0
- package/dist/configurators/copilot.js +34 -0
- package/dist/configurators/copilot.js.map +1 -0
- package/dist/configurators/index.d.ts +11 -1
- package/dist/configurators/index.d.ts.map +1 -1
- package/dist/configurators/index.js +72 -4
- package/dist/configurators/index.js.map +1 -1
- package/dist/configurators/opencode.d.ts +1 -1
- package/dist/configurators/opencode.js +1 -1
- package/dist/configurators/windsurf.d.ts +8 -0
- package/dist/configurators/windsurf.d.ts.map +1 -0
- package/dist/configurators/windsurf.js +18 -0
- package/dist/configurators/windsurf.js.map +1 -0
- package/dist/configurators/workflow.d.ts +6 -2
- package/dist/configurators/workflow.d.ts.map +1 -1
- package/dist/configurators/workflow.js +90 -58
- package/dist/configurators/workflow.js.map +1 -1
- package/dist/migrations/index.d.ts +1 -0
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +2 -0
- package/dist/migrations/index.js.map +1 -1
- package/dist/migrations/manifests/0.4.0-beta.1.json +228 -0
- package/dist/migrations/manifests/0.4.0-beta.10.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.2.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.3.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.4.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.5.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.6.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.7.json +9 -0
- package/dist/migrations/manifests/0.4.0-beta.8.json +34 -0
- package/dist/migrations/manifests/0.4.0-beta.9.json +9 -0
- package/dist/templates/claude/agents/dispatch.md +1 -2
- package/dist/templates/claude/agents/implement.md +2 -3
- package/dist/templates/claude/commands/trellis/before-dev.md +29 -0
- package/dist/templates/claude/commands/trellis/check.md +25 -0
- package/dist/templates/claude/commands/trellis/create-command.md +2 -2
- package/dist/templates/claude/commands/trellis/onboard.md +13 -13
- package/dist/templates/claude/commands/trellis/parallel.md +1 -2
- package/dist/templates/claude/commands/trellis/record-session.md +3 -2
- package/dist/templates/claude/commands/trellis/start.md +8 -4
- package/dist/templates/claude/hooks/inject-subagent-context.py +29 -14
- package/dist/templates/claude/hooks/ralph-loop.py +18 -10
- package/dist/templates/claude/hooks/session-start.py +201 -9
- package/dist/templates/claude/hooks/statusline.py +211 -0
- package/dist/templates/claude/settings.json +4 -0
- package/dist/templates/codebuddy/commands/trellis/before-dev.md +29 -0
- package/dist/templates/codebuddy/commands/trellis/brainstorm.md +487 -0
- package/dist/templates/codebuddy/commands/trellis/break-loop.md +107 -0
- package/dist/templates/codebuddy/commands/trellis/check-cross-layer.md +153 -0
- package/dist/templates/codebuddy/commands/trellis/check.md +25 -0
- package/dist/templates/codebuddy/commands/trellis/create-command.md +154 -0
- package/dist/templates/codebuddy/commands/trellis/finish-work.md +143 -0
- package/dist/templates/codebuddy/commands/trellis/integrate-skill.md +219 -0
- package/dist/templates/codebuddy/commands/trellis/onboard.md +358 -0
- package/dist/templates/codebuddy/commands/trellis/record-session.md +61 -0
- package/dist/templates/codebuddy/commands/trellis/start.md +373 -0
- package/dist/templates/codebuddy/commands/trellis/update-spec.md +354 -0
- package/dist/templates/codebuddy/index.d.ts +25 -0
- package/dist/templates/codebuddy/index.d.ts.map +1 -0
- package/dist/templates/codebuddy/index.js +45 -0
- package/dist/templates/codebuddy/index.js.map +1 -0
- package/dist/templates/codex/agents/check.toml +23 -0
- package/dist/templates/codex/agents/implement.toml +19 -0
- package/dist/templates/codex/agents/research.toml +26 -0
- package/dist/templates/codex/codex-skills/parallel/SKILL.md +194 -0
- package/dist/templates/codex/config.toml +5 -0
- package/dist/templates/codex/hooks/session-start.py +228 -0
- package/dist/templates/codex/hooks.json +16 -0
- package/dist/templates/codex/index.d.ts +27 -5
- package/dist/templates/codex/index.d.ts.map +1 -1
- package/dist/templates/codex/index.js +60 -8
- package/dist/templates/codex/index.js.map +1 -1
- package/dist/templates/codex/skills/before-dev/SKILL.md +34 -0
- package/dist/templates/codex/skills/brainstorm/SKILL.md +1 -1
- package/dist/templates/codex/skills/break-loop/SKILL.md +1 -1
- package/dist/templates/codex/skills/check/SKILL.md +30 -0
- package/dist/templates/codex/skills/check-cross-layer/SKILL.md +1 -1
- package/dist/templates/codex/skills/create-command/SKILL.md +3 -3
- package/dist/templates/codex/skills/finish-work/SKILL.md +1 -1
- package/dist/templates/codex/skills/improve-ut/SKILL.md +69 -0
- package/dist/templates/codex/skills/integrate-skill/SKILL.md +1 -1
- package/dist/templates/codex/skills/onboard/SKILL.md +12 -12
- package/dist/templates/codex/skills/record-session/SKILL.md +4 -3
- package/dist/templates/codex/skills/start/SKILL.md +9 -4
- package/dist/templates/codex/skills/update-spec/SKILL.md +1 -1
- package/dist/templates/copilot/hooks/session-start.py +218 -0
- package/dist/templates/copilot/hooks.json +11 -0
- package/dist/templates/copilot/index.d.ts +23 -0
- package/dist/templates/copilot/index.d.ts.map +1 -0
- package/dist/templates/copilot/index.js +54 -0
- package/dist/templates/copilot/index.js.map +1 -0
- package/dist/templates/copilot/prompts/before-dev.prompt.md +33 -0
- package/dist/templates/copilot/prompts/brainstorm.prompt.md +491 -0
- package/dist/templates/copilot/prompts/break-loop.prompt.md +129 -0
- package/dist/templates/copilot/prompts/check-cross-layer.prompt.md +157 -0
- package/dist/templates/copilot/prompts/check.prompt.md +29 -0
- package/dist/templates/copilot/prompts/create-command.prompt.md +116 -0
- package/dist/templates/copilot/prompts/finish-work.prompt.md +157 -0
- package/dist/templates/copilot/prompts/integrate-skill.prompt.md +223 -0
- package/dist/templates/copilot/prompts/onboard.prompt.md +362 -0
- package/dist/templates/copilot/prompts/parallel.prompt.md +196 -0
- package/dist/templates/copilot/prompts/record-session.prompt.md +66 -0
- package/dist/templates/copilot/prompts/start.prompt.md +397 -0
- package/dist/templates/copilot/prompts/update-spec.prompt.md +358 -0
- package/dist/templates/cursor/commands/trellis-before-dev.md +29 -0
- package/dist/templates/cursor/commands/trellis-check.md +25 -0
- package/dist/templates/cursor/commands/trellis-create-command.md +2 -2
- package/dist/templates/cursor/commands/trellis-onboard.md +13 -13
- package/dist/templates/cursor/commands/trellis-record-session.md +3 -2
- package/dist/templates/cursor/commands/trellis-start.md +7 -16
- package/dist/templates/extract.d.ts +36 -0
- package/dist/templates/extract.d.ts.map +1 -1
- package/dist/templates/extract.js +64 -0
- package/dist/templates/extract.js.map +1 -1
- package/dist/templates/gemini/commands/trellis/before-dev.toml +33 -0
- package/dist/templates/gemini/commands/trellis/check.toml +29 -0
- package/dist/templates/gemini/commands/trellis/create-command.toml +2 -2
- package/dist/templates/gemini/commands/trellis/onboard.toml +2 -2
- package/dist/templates/gemini/commands/trellis/record-session.toml +3 -2
- package/dist/templates/gemini/commands/trellis/start.toml +9 -4
- package/dist/templates/iflow/agents/dispatch.md +1 -2
- package/dist/templates/iflow/agents/implement.md +2 -3
- package/dist/templates/iflow/commands/trellis/before-dev.md +29 -0
- package/dist/templates/iflow/commands/trellis/check.md +25 -0
- package/dist/templates/iflow/commands/trellis/create-command.md +2 -2
- package/dist/templates/iflow/commands/trellis/onboard.md +13 -13
- package/dist/templates/iflow/commands/trellis/parallel.md +1 -2
- package/dist/templates/iflow/commands/trellis/record-session.md +3 -2
- package/dist/templates/iflow/commands/trellis/start.md +8 -4
- package/dist/templates/iflow/hooks/inject-subagent-context.py +29 -14
- package/dist/templates/iflow/hooks/ralph-loop.py +8 -1
- package/dist/templates/iflow/hooks/session-start.py +187 -8
- package/dist/templates/kilo/workflows/before-dev.md +29 -0
- package/dist/templates/kilo/workflows/check.md +25 -0
- package/dist/templates/kilo/workflows/create-command.md +2 -2
- package/dist/templates/kilo/workflows/onboard.md +13 -13
- package/dist/templates/kilo/workflows/parallel.md +1 -2
- package/dist/templates/kilo/workflows/record-session.md +3 -2
- package/dist/templates/kilo/workflows/start.md +8 -3
- package/dist/templates/kiro/skills/before-dev/SKILL.md +34 -0
- package/dist/templates/kiro/skills/brainstorm/SKILL.md +1 -1
- package/dist/templates/kiro/skills/break-loop/SKILL.md +1 -1
- package/dist/templates/kiro/skills/check/SKILL.md +30 -0
- package/dist/templates/kiro/skills/check-cross-layer/SKILL.md +1 -1
- package/dist/templates/kiro/skills/create-command/SKILL.md +3 -3
- package/dist/templates/kiro/skills/finish-work/SKILL.md +1 -1
- package/dist/templates/kiro/skills/integrate-skill/SKILL.md +1 -1
- package/dist/templates/kiro/skills/onboard/SKILL.md +12 -12
- package/dist/templates/kiro/skills/record-session/SKILL.md +4 -3
- package/dist/templates/kiro/skills/start/SKILL.md +9 -4
- package/dist/templates/kiro/skills/update-spec/SKILL.md +1 -1
- package/dist/templates/markdown/agents.md +4 -0
- package/dist/templates/markdown/spec/backend/directory-structure.md +1 -1
- package/dist/templates/markdown/spec/backend/script-conventions.md +93 -0
- package/dist/templates/markdown/workspace-index.md +2 -0
- package/dist/templates/opencode/agents/dispatch.md +21 -21
- package/dist/templates/opencode/agents/implement.md +2 -2
- package/dist/templates/opencode/agents/research.md +1 -2
- package/dist/templates/opencode/commands/trellis/before-dev.md +29 -0
- package/dist/templates/opencode/commands/trellis/check.md +25 -0
- package/dist/templates/opencode/commands/trellis/create-command.md +2 -2
- package/dist/templates/opencode/commands/trellis/onboard.md +13 -13
- package/dist/templates/opencode/commands/trellis/parallel.md +1 -2
- package/dist/templates/opencode/commands/trellis/record-session.md +3 -2
- package/dist/templates/opencode/commands/trellis/start.md +8 -3
- package/dist/templates/opencode/lib/trellis-context.js +42 -2
- package/dist/templates/opencode/{plugin → plugins}/inject-subagent-context.js +45 -18
- package/dist/templates/opencode/{plugin → plugins}/session-start.js +156 -28
- package/dist/templates/qoder/skills/before-dev/SKILL.md +34 -0
- package/dist/templates/qoder/skills/brainstorm/SKILL.md +1 -1
- package/dist/templates/qoder/skills/break-loop/SKILL.md +1 -1
- package/dist/templates/qoder/skills/check/SKILL.md +30 -0
- package/dist/templates/qoder/skills/check-cross-layer/SKILL.md +1 -1
- package/dist/templates/qoder/skills/create-command/SKILL.md +3 -3
- package/dist/templates/qoder/skills/finish-work/SKILL.md +1 -1
- package/dist/templates/qoder/skills/integrate-skill/SKILL.md +1 -1
- package/dist/templates/qoder/skills/onboard/SKILL.md +14 -14
- package/dist/templates/qoder/skills/record-session/SKILL.md +4 -3
- package/dist/templates/qoder/skills/start/SKILL.md +9 -4
- package/dist/templates/qoder/skills/update-spec/SKILL.md +1 -1
- package/dist/templates/trellis/config.yaml +20 -0
- package/dist/templates/trellis/index.d.ts +11 -0
- package/dist/templates/trellis/index.d.ts.map +1 -1
- package/dist/templates/trellis/index.js +22 -0
- package/dist/templates/trellis/index.js.map +1 -1
- package/dist/templates/trellis/scripts/add_session.py +111 -13
- package/dist/templates/trellis/scripts/common/__init__.py +2 -0
- package/dist/templates/trellis/scripts/common/cli_adapter.py +164 -64
- package/dist/templates/trellis/scripts/common/config.py +192 -0
- package/dist/templates/trellis/scripts/common/developer.py +2 -2
- package/dist/templates/trellis/scripts/common/git.py +31 -0
- package/dist/templates/trellis/scripts/common/git_context.py +23 -586
- package/dist/templates/trellis/scripts/common/io.py +37 -0
- package/dist/templates/trellis/scripts/common/log.py +45 -0
- package/dist/templates/trellis/scripts/common/packages_context.py +238 -0
- package/dist/templates/trellis/scripts/common/paths.py +103 -6
- package/dist/templates/trellis/scripts/common/phase.py +50 -49
- package/dist/templates/trellis/scripts/common/registry.py +41 -72
- package/dist/templates/trellis/scripts/common/session_context.py +562 -0
- package/dist/templates/trellis/scripts/common/task_context.py +410 -0
- package/dist/templates/trellis/scripts/common/task_queue.py +27 -98
- package/dist/templates/trellis/scripts/common/task_store.py +536 -0
- package/dist/templates/trellis/scripts/common/task_utils.py +106 -10
- package/dist/templates/trellis/scripts/common/tasks.py +109 -0
- package/dist/templates/trellis/scripts/common/types.py +112 -0
- package/dist/templates/trellis/scripts/create_bootstrap.py +32 -27
- package/dist/templates/trellis/scripts/hooks/linear_sync.py +243 -0
- package/dist/templates/trellis/scripts/multi_agent/_bootstrap.py +17 -0
- package/dist/templates/trellis/scripts/multi_agent/cleanup.py +43 -48
- package/dist/templates/trellis/scripts/multi_agent/create_pr.py +336 -45
- package/dist/templates/trellis/scripts/multi_agent/plan.py +9 -32
- package/dist/templates/trellis/scripts/multi_agent/start.py +142 -68
- package/dist/templates/trellis/scripts/multi_agent/status.py +12 -753
- package/dist/templates/trellis/scripts/multi_agent/status_display.py +542 -0
- package/dist/templates/trellis/scripts/multi_agent/status_monitor.py +225 -0
- package/dist/templates/trellis/scripts/task.py +51 -976
- package/dist/templates/trellis/scripts-shell-archive/create-bootstrap.sh +1 -1
- package/dist/templates/trellis/workflow.md +38 -38
- package/dist/templates/windsurf/index.d.ts +21 -0
- package/dist/templates/windsurf/index.d.ts.map +1 -0
- package/dist/templates/windsurf/index.js +44 -0
- package/dist/templates/windsurf/index.js.map +1 -0
- package/dist/templates/windsurf/workflows/trellis-before-dev.md +31 -0
- package/dist/templates/windsurf/workflows/trellis-brainstorm.md +491 -0
- package/dist/templates/windsurf/workflows/trellis-break-loop.md +111 -0
- package/dist/templates/windsurf/workflows/trellis-check-cross-layer.md +157 -0
- package/dist/templates/windsurf/workflows/trellis-check.md +27 -0
- package/dist/templates/windsurf/workflows/trellis-create-command.md +154 -0
- package/dist/templates/windsurf/workflows/trellis-finish-work.md +147 -0
- package/dist/templates/windsurf/workflows/trellis-integrate-skill.md +220 -0
- package/dist/templates/windsurf/workflows/trellis-onboard.md +362 -0
- package/dist/templates/windsurf/workflows/trellis-record-session.md +66 -0
- package/dist/templates/windsurf/workflows/trellis-start.md +373 -0
- package/dist/templates/windsurf/workflows/trellis-update-spec.md +358 -0
- package/dist/types/ai-tools.d.ts +15 -3
- package/dist/types/ai-tools.d.ts.map +1 -1
- package/dist/types/ai-tools.js +42 -2
- package/dist/types/ai-tools.js.map +1 -1
- package/dist/types/migration.d.ts +3 -1
- package/dist/types/migration.d.ts.map +1 -1
- package/dist/utils/project-detector.d.ts +28 -0
- package/dist/utils/project-detector.d.ts.map +1 -1
- package/dist/utils/project-detector.js +371 -0
- package/dist/utils/project-detector.js.map +1 -1
- package/dist/utils/template-fetcher.d.ts +19 -6
- package/dist/utils/template-fetcher.d.ts.map +1 -1
- package/dist/utils/template-fetcher.js +99 -17
- package/dist/utils/template-fetcher.js.map +1 -1
- package/package.json +1 -1
- package/dist/templates/claude/commands/trellis/before-backend-dev.md +0 -13
- package/dist/templates/claude/commands/trellis/before-frontend-dev.md +0 -13
- package/dist/templates/claude/commands/trellis/check-backend.md +0 -13
- package/dist/templates/claude/commands/trellis/check-frontend.md +0 -13
- package/dist/templates/codex/skills/before-backend-dev/SKILL.md +0 -18
- package/dist/templates/codex/skills/before-frontend-dev/SKILL.md +0 -18
- package/dist/templates/codex/skills/check-backend/SKILL.md +0 -18
- package/dist/templates/codex/skills/check-frontend/SKILL.md +0 -18
- package/dist/templates/cursor/commands/trellis-before-backend-dev.md +0 -13
- package/dist/templates/cursor/commands/trellis-before-frontend-dev.md +0 -13
- package/dist/templates/cursor/commands/trellis-check-backend.md +0 -13
- package/dist/templates/cursor/commands/trellis-check-frontend.md +0 -13
- package/dist/templates/gemini/commands/trellis/before-backend-dev.toml +0 -17
- package/dist/templates/gemini/commands/trellis/before-frontend-dev.toml +0 -17
- package/dist/templates/gemini/commands/trellis/check-backend.toml +0 -17
- package/dist/templates/gemini/commands/trellis/check-frontend.toml +0 -17
- package/dist/templates/iflow/commands/trellis/before-backend-dev.md +0 -13
- package/dist/templates/iflow/commands/trellis/before-frontend-dev.md +0 -13
- package/dist/templates/iflow/commands/trellis/check-backend.md +0 -13
- package/dist/templates/iflow/commands/trellis/check-frontend.md +0 -13
- package/dist/templates/kilo/workflows/before-backend-dev.md +0 -13
- package/dist/templates/kilo/workflows/before-frontend-dev.md +0 -13
- package/dist/templates/kilo/workflows/check-backend.md +0 -13
- package/dist/templates/kilo/workflows/check-frontend.md +0 -13
- package/dist/templates/kiro/skills/before-backend-dev/SKILL.md +0 -18
- package/dist/templates/kiro/skills/before-frontend-dev/SKILL.md +0 -18
- package/dist/templates/kiro/skills/check-backend/SKILL.md +0 -18
- package/dist/templates/kiro/skills/check-frontend/SKILL.md +0 -18
- package/dist/templates/opencode/commands/trellis/before-backend-dev.md +0 -13
- package/dist/templates/opencode/commands/trellis/before-frontend-dev.md +0 -13
- package/dist/templates/opencode/commands/trellis/check-backend.md +0 -13
- package/dist/templates/opencode/commands/trellis/check-frontend.md +0 -13
- package/dist/templates/qoder/skills/before-backend-dev/SKILL.md +0 -18
- package/dist/templates/qoder/skills/before-frontend-dev/SKILL.md +0 -18
- package/dist/templates/qoder/skills/check-backend/SKILL.md +0 -18
- package/dist/templates/qoder/skills/check-frontend/SKILL.md +0 -18
|
@@ -0,0 +1,358 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Trellis Copilot prompt: Update Code-Spec - Capture Executable Contracts"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Update Code-Spec - Capture Executable Contracts
|
|
6
|
+
|
|
7
|
+
When you learn something valuable (from debugging, implementing, or discussion), use this command to update the relevant code-spec documents.
|
|
8
|
+
|
|
9
|
+
**Timing**: After completing a task, fixing a bug, or discovering a new pattern
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Code-Spec First Rule (CRITICAL)
|
|
14
|
+
|
|
15
|
+
In this project, "spec" for implementation work means **code-spec**:
|
|
16
|
+
- Executable contracts (not principle-only text)
|
|
17
|
+
- Concrete signatures, payload fields, env keys, and boundary behavior
|
|
18
|
+
- Testable validation/error behavior
|
|
19
|
+
|
|
20
|
+
If the change touches infra or cross-layer contracts, code-spec depth is mandatory.
|
|
21
|
+
|
|
22
|
+
### Mandatory Triggers
|
|
23
|
+
|
|
24
|
+
Apply code-spec depth when the change includes any of:
|
|
25
|
+
- New/changed command or API signature
|
|
26
|
+
- Cross-layer request/response contract change
|
|
27
|
+
- Database schema/migration change
|
|
28
|
+
- Infra integration (storage, queue, cache, secrets, env wiring)
|
|
29
|
+
|
|
30
|
+
### Mandatory Output (7 Sections)
|
|
31
|
+
|
|
32
|
+
For triggered tasks, include all sections below:
|
|
33
|
+
1. Scope / Trigger
|
|
34
|
+
2. Signatures (command/API/DB)
|
|
35
|
+
3. Contracts (request/response/env)
|
|
36
|
+
4. Validation & Error Matrix
|
|
37
|
+
5. Good/Base/Bad Cases
|
|
38
|
+
6. Tests Required (with assertion points)
|
|
39
|
+
7. Wrong vs Correct (at least one pair)
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## When to Update Code-Specs
|
|
44
|
+
|
|
45
|
+
| Trigger | Example | Target Spec |
|
|
46
|
+
|---------|---------|-------------|
|
|
47
|
+
| **Implemented a feature** | Added template download with giget | Relevant `backend/` or `frontend/` file |
|
|
48
|
+
| **Made a design decision** | Used type field + mapping table for extensibility | Relevant code-spec + "Design Decisions" section |
|
|
49
|
+
| **Fixed a bug** | Found a subtle issue with error handling | `backend/error-handling.md` |
|
|
50
|
+
| **Discovered a pattern** | Found a better way to structure code | Relevant `backend/` or `frontend/` file |
|
|
51
|
+
| **Hit a gotcha** | Learned that X must be done before Y | Relevant code-spec + "Common Mistakes" section |
|
|
52
|
+
| **Established a convention** | Team agreed on naming pattern | `quality-guidelines.md` |
|
|
53
|
+
| **New thinking trigger** | "Don't forget to check X before doing Y" | `guides/*.md` (as a checklist item, not detailed rules) |
|
|
54
|
+
|
|
55
|
+
**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.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Spec Structure Overview
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
.trellis/spec/
|
|
63
|
+
├── backend/ # Backend coding standards
|
|
64
|
+
�? ├── index.md # Overview and links
|
|
65
|
+
�? └── *.md # Topic-specific guidelines
|
|
66
|
+
├── frontend/ # Frontend coding standards
|
|
67
|
+
�? ├── index.md # Overview and links
|
|
68
|
+
�? └── *.md # Topic-specific guidelines
|
|
69
|
+
└── guides/ # Thinking checklists (NOT coding specs!)
|
|
70
|
+
├── index.md # Guide index
|
|
71
|
+
└── *.md # Topic-specific guides
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### CRITICAL: Code-Spec vs Guide - Know the Difference
|
|
75
|
+
|
|
76
|
+
| Type | Location | Purpose | Content Style |
|
|
77
|
+
|------|----------|---------|---------------|
|
|
78
|
+
| **Code-Spec** | `backend/*.md`, `frontend/*.md` | Tell AI "how to implement safely" | Signatures, contracts, matrices, cases, test points |
|
|
79
|
+
| **Guide** | `guides/*.md` | Help AI "what to think about" | Checklists, questions, pointers to specs |
|
|
80
|
+
|
|
81
|
+
**Decision Rule**: Ask yourself:
|
|
82
|
+
|
|
83
|
+
- "This is **how to write** the code" �?Put in `backend/` or `frontend/`
|
|
84
|
+
- "This is **what to consider** before writing" �?Put in `guides/`
|
|
85
|
+
|
|
86
|
+
**Example**:
|
|
87
|
+
|
|
88
|
+
| Learning | Wrong Location | Correct Location |
|
|
89
|
+
|----------|----------------|------------------|
|
|
90
|
+
| "Use `reconfigure()` not `TextIOWrapper` for Windows stdout" | �?`guides/cross-platform-thinking-guide.md` | �?`backend/script-conventions.md` |
|
|
91
|
+
| "Remember to check encoding when writing cross-platform code" | �?`backend/script-conventions.md` | �?`guides/cross-platform-thinking-guide.md` |
|
|
92
|
+
|
|
93
|
+
**Guides should be short checklists that point to specs**, not duplicate the detailed rules.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Update Process
|
|
98
|
+
|
|
99
|
+
### Step 1: Identify What You Learned
|
|
100
|
+
|
|
101
|
+
Answer these questions:
|
|
102
|
+
|
|
103
|
+
1. **What did you learn?** (Be specific)
|
|
104
|
+
2. **Why is it important?** (What problem does it prevent?)
|
|
105
|
+
3. **Where does it belong?** (Which spec file?)
|
|
106
|
+
|
|
107
|
+
### Step 2: Classify the Update Type
|
|
108
|
+
|
|
109
|
+
| Type | Description | Action |
|
|
110
|
+
|------|-------------|--------|
|
|
111
|
+
| **Design Decision** | Why we chose approach X over Y | Add to "Design Decisions" section |
|
|
112
|
+
| **Project Convention** | How we do X in this project | Add to relevant section with examples |
|
|
113
|
+
| **New Pattern** | A reusable approach discovered | Add to "Patterns" section |
|
|
114
|
+
| **Forbidden Pattern** | Something that causes problems | Add to "Anti-patterns" or "Don't" section |
|
|
115
|
+
| **Common Mistake** | Easy-to-make error | Add to "Common Mistakes" section |
|
|
116
|
+
| **Convention** | Agreed-upon standard | Add to relevant section |
|
|
117
|
+
| **Gotcha** | Non-obvious behavior | Add warning callout |
|
|
118
|
+
|
|
119
|
+
### Step 3: Read the Target Code-Spec
|
|
120
|
+
|
|
121
|
+
Before editing, read the current code-spec to:
|
|
122
|
+
- Understand existing structure
|
|
123
|
+
- Avoid duplicating content
|
|
124
|
+
- Find the right section for your update
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
cat .trellis/spec/<category>/<file>.md
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Step 4: Make the Update
|
|
131
|
+
|
|
132
|
+
Follow these principles:
|
|
133
|
+
|
|
134
|
+
1. **Be Specific**: Include concrete examples, not just abstract rules
|
|
135
|
+
2. **Explain Why**: State the problem this prevents
|
|
136
|
+
3. **Show Contracts**: Add signatures, payload fields, and error behavior
|
|
137
|
+
4. **Show Code**: Add code snippets for key patterns
|
|
138
|
+
5. **Keep it Short**: One concept per section
|
|
139
|
+
|
|
140
|
+
### Step 5: Update the Index (if needed)
|
|
141
|
+
|
|
142
|
+
If you added a new section or the code-spec status changed, update the category's `index.md`.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Update Templates
|
|
147
|
+
|
|
148
|
+
### Mandatory Template for Infra/Cross-Layer Work
|
|
149
|
+
|
|
150
|
+
```markdown
|
|
151
|
+
## Scenario: <name>
|
|
152
|
+
|
|
153
|
+
### 1. Scope / Trigger
|
|
154
|
+
- Trigger: <why this requires code-spec depth>
|
|
155
|
+
|
|
156
|
+
### 2. Signatures
|
|
157
|
+
- Backend command/API/DB signature(s)
|
|
158
|
+
|
|
159
|
+
### 3. Contracts
|
|
160
|
+
- Request fields (name, type, constraints)
|
|
161
|
+
- Response fields (name, type, constraints)
|
|
162
|
+
- Environment keys (required/optional)
|
|
163
|
+
|
|
164
|
+
### 4. Validation & Error Matrix
|
|
165
|
+
- <condition> -> <error>
|
|
166
|
+
|
|
167
|
+
### 5. Good/Base/Bad Cases
|
|
168
|
+
- Good: ...
|
|
169
|
+
- Base: ...
|
|
170
|
+
- Bad: ...
|
|
171
|
+
|
|
172
|
+
### 6. Tests Required
|
|
173
|
+
- Unit/Integration/E2E with assertion points
|
|
174
|
+
|
|
175
|
+
### 7. Wrong vs Correct
|
|
176
|
+
#### Wrong
|
|
177
|
+
...
|
|
178
|
+
#### Correct
|
|
179
|
+
...
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Adding a Design Decision
|
|
183
|
+
|
|
184
|
+
```markdown
|
|
185
|
+
### Design Decision: [Decision Name]
|
|
186
|
+
|
|
187
|
+
**Context**: What problem were we solving?
|
|
188
|
+
|
|
189
|
+
**Options Considered**:
|
|
190
|
+
1. Option A - brief description
|
|
191
|
+
2. Option B - brief description
|
|
192
|
+
|
|
193
|
+
**Decision**: We chose Option X because...
|
|
194
|
+
|
|
195
|
+
**Example**:
|
|
196
|
+
\`\`\`typescript
|
|
197
|
+
// How it's implemented
|
|
198
|
+
code example
|
|
199
|
+
\`\`\`
|
|
200
|
+
|
|
201
|
+
**Extensibility**: How to extend this in the future...
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Adding a Project Convention
|
|
205
|
+
|
|
206
|
+
```markdown
|
|
207
|
+
### Convention: [Convention Name]
|
|
208
|
+
|
|
209
|
+
**What**: Brief description of the convention.
|
|
210
|
+
|
|
211
|
+
**Why**: Why we do it this way in this project.
|
|
212
|
+
|
|
213
|
+
**Example**:
|
|
214
|
+
\`\`\`typescript
|
|
215
|
+
// How to follow this convention
|
|
216
|
+
code example
|
|
217
|
+
\`\`\`
|
|
218
|
+
|
|
219
|
+
**Related**: Links to related conventions or specs.
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Adding a New Pattern
|
|
223
|
+
|
|
224
|
+
```markdown
|
|
225
|
+
### Pattern Name
|
|
226
|
+
|
|
227
|
+
**Problem**: What problem does this solve?
|
|
228
|
+
|
|
229
|
+
**Solution**: Brief description of the approach.
|
|
230
|
+
|
|
231
|
+
**Example**:
|
|
232
|
+
\`\`\`
|
|
233
|
+
// Good
|
|
234
|
+
code example
|
|
235
|
+
|
|
236
|
+
// Bad
|
|
237
|
+
code example
|
|
238
|
+
\`\`\`
|
|
239
|
+
|
|
240
|
+
**Why**: Explanation of why this works better.
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Adding a Forbidden Pattern
|
|
244
|
+
|
|
245
|
+
```markdown
|
|
246
|
+
### Don't: Pattern Name
|
|
247
|
+
|
|
248
|
+
**Problem**:
|
|
249
|
+
\`\`\`
|
|
250
|
+
// Don't do this
|
|
251
|
+
bad code example
|
|
252
|
+
\`\`\`
|
|
253
|
+
|
|
254
|
+
**Why it's bad**: Explanation of the issue.
|
|
255
|
+
|
|
256
|
+
**Instead**:
|
|
257
|
+
\`\`\`
|
|
258
|
+
// Do this instead
|
|
259
|
+
good code example
|
|
260
|
+
\`\`\`
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Adding a Common Mistake
|
|
264
|
+
|
|
265
|
+
```markdown
|
|
266
|
+
### Common Mistake: Description
|
|
267
|
+
|
|
268
|
+
**Symptom**: What goes wrong
|
|
269
|
+
|
|
270
|
+
**Cause**: Why this happens
|
|
271
|
+
|
|
272
|
+
**Fix**: How to correct it
|
|
273
|
+
|
|
274
|
+
**Prevention**: How to avoid it in the future
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Adding a Gotcha
|
|
278
|
+
|
|
279
|
+
```markdown
|
|
280
|
+
> **Warning**: Brief description of the non-obvious behavior.
|
|
281
|
+
>
|
|
282
|
+
> Details about when this happens and how to handle it.
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
## Interactive Mode
|
|
288
|
+
|
|
289
|
+
If you're unsure what to update, answer these prompts:
|
|
290
|
+
|
|
291
|
+
1. **What did you just finish?**
|
|
292
|
+
- [ ] Fixed a bug
|
|
293
|
+
- [ ] Implemented a feature
|
|
294
|
+
- [ ] Refactored code
|
|
295
|
+
- [ ] Had a discussion about approach
|
|
296
|
+
|
|
297
|
+
2. **What did you learn or decide?**
|
|
298
|
+
- Design decision (why X over Y)
|
|
299
|
+
- Project convention (how we do X)
|
|
300
|
+
- Non-obvious behavior (gotcha)
|
|
301
|
+
- Better approach (pattern)
|
|
302
|
+
|
|
303
|
+
3. **Would future AI/developers need to know this?**
|
|
304
|
+
- To understand how the code works �?Yes, update spec
|
|
305
|
+
- To maintain or extend the feature �?Yes, update spec
|
|
306
|
+
- To avoid repeating mistakes �?Yes, update spec
|
|
307
|
+
- Purely one-off implementation detail �?Maybe skip
|
|
308
|
+
|
|
309
|
+
4. **Which area does it relate to?**
|
|
310
|
+
- [ ] Backend code
|
|
311
|
+
- [ ] Frontend code
|
|
312
|
+
- [ ] Cross-layer data flow
|
|
313
|
+
- [ ] Code organization/reuse
|
|
314
|
+
- [ ] Quality/testing
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
## Quality Checklist
|
|
319
|
+
|
|
320
|
+
Before finishing your code-spec update:
|
|
321
|
+
|
|
322
|
+
- [ ] Is the content specific and actionable?
|
|
323
|
+
- [ ] Did you include a code example?
|
|
324
|
+
- [ ] Did you explain WHY, not just WHAT?
|
|
325
|
+
- [ ] Did you include executable signatures/contracts?
|
|
326
|
+
- [ ] Did you include validation and error matrix?
|
|
327
|
+
- [ ] Did you include Good/Base/Bad cases?
|
|
328
|
+
- [ ] Did you include required tests with assertion points?
|
|
329
|
+
- [ ] Is it in the right code-spec file?
|
|
330
|
+
- [ ] Does it duplicate existing content?
|
|
331
|
+
- [ ] Would a new team member understand it?
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
## Relationship to Other Commands
|
|
336
|
+
|
|
337
|
+
```
|
|
338
|
+
Development Flow:
|
|
339
|
+
Learn something �?/ �?Knowledge captured
|
|
340
|
+
�? �?
|
|
341
|
+
/ ←──────────────────── Future sessions benefit
|
|
342
|
+
(deep bug analysis)
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
- `/` - Analyzes bugs deeply, often reveals spec updates needed
|
|
346
|
+
- `/` - Actually makes the updates (this command)
|
|
347
|
+
- `/` - Reminds you to check if specs need updates
|
|
348
|
+
|
|
349
|
+
---
|
|
350
|
+
|
|
351
|
+
## Core Philosophy
|
|
352
|
+
|
|
353
|
+
> **Code-specs are living documents. Every debugging session, every "aha moment" is an opportunity to make the implementation contract clearer.**
|
|
354
|
+
|
|
355
|
+
The goal is **institutional memory**:
|
|
356
|
+
- What one person learns, everyone benefits from
|
|
357
|
+
- What AI learns in one session, persists to future sessions
|
|
358
|
+
- Mistakes become documented guardrails
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
Read the relevant development guidelines before starting your task.
|
|
2
|
+
|
|
3
|
+
Execute these steps:
|
|
4
|
+
|
|
5
|
+
1. **Discover packages and their spec layers**:
|
|
6
|
+
```bash
|
|
7
|
+
python3 ./.trellis/scripts/get_context.py --mode packages
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
2. **Identify which specs apply** to your task based on:
|
|
11
|
+
- Which package you're modifying (e.g., `cli/`, `docs-site/`)
|
|
12
|
+
- What type of work (backend, frontend, unit-test, docs, etc.)
|
|
13
|
+
|
|
14
|
+
3. **Read the spec index** for each relevant module:
|
|
15
|
+
```bash
|
|
16
|
+
cat .trellis/spec/<package>/<layer>/index.md
|
|
17
|
+
```
|
|
18
|
+
Follow the **"Pre-Development Checklist"** section in the index.
|
|
19
|
+
|
|
20
|
+
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.
|
|
21
|
+
|
|
22
|
+
5. **Always read shared guides**:
|
|
23
|
+
```bash
|
|
24
|
+
cat .trellis/spec/guides/index.md
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
6. Understand the coding standards and patterns you need to follow, then proceed with your development plan.
|
|
28
|
+
|
|
29
|
+
This step is **mandatory** before writing any code.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
Check if the code you just wrote follows the development guidelines.
|
|
2
|
+
|
|
3
|
+
Execute these steps:
|
|
4
|
+
|
|
5
|
+
1. **Identify changed files**:
|
|
6
|
+
```bash
|
|
7
|
+
git diff --name-only HEAD
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
2. **Determine which spec modules apply** based on the changed file paths:
|
|
11
|
+
```bash
|
|
12
|
+
python3 ./.trellis/scripts/get_context.py --mode packages
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
3. **Read the spec index** for each relevant module:
|
|
16
|
+
```bash
|
|
17
|
+
cat .trellis/spec/<package>/<layer>/index.md
|
|
18
|
+
```
|
|
19
|
+
Follow the **"Quality Check"** section in the index.
|
|
20
|
+
|
|
21
|
+
4. **Read the specific guideline files** referenced in the Quality Check section (e.g., `quality-guidelines.md`, `conventions.md`). The index is NOT the goal — it points you to the actual guideline files. Read those files and review your code against them.
|
|
22
|
+
|
|
23
|
+
5. **Run lint and typecheck** for the affected package.
|
|
24
|
+
|
|
25
|
+
6. **Report any violations** and fix them if found.
|
|
@@ -101,8 +101,8 @@ Description:
|
|
|
101
101
|
| Command Type | Prefix | Example |
|
|
102
102
|
|--------------|--------|---------|
|
|
103
103
|
| Session Start | `start` | `start` |
|
|
104
|
-
| Pre-development | `before-` | `before-
|
|
105
|
-
| Check | `check-` | `check
|
|
104
|
+
| Pre-development | `before-` | `before-dev` |
|
|
105
|
+
| Check | `check-` | `check` |
|
|
106
106
|
| Record | `record-` | `record-session` |
|
|
107
107
|
| Generate | `generate-` | `generate-api-doc` |
|
|
108
108
|
| Update | `update-` | `update-changelog` |
|
|
@@ -126,13 +126,13 @@ AI needs the same onboarding - but compressed into seconds at session start.
|
|
|
126
126
|
|
|
127
127
|
---
|
|
128
128
|
|
|
129
|
-
### /trellis-before-
|
|
129
|
+
### /trellis-before-dev - Inject Specialized Knowledge
|
|
130
130
|
|
|
131
131
|
**WHY IT EXISTS**:
|
|
132
132
|
AI models have "pre-trained knowledge" - general patterns from millions of codebases. But YOUR project has specific conventions that differ from generic patterns.
|
|
133
133
|
|
|
134
134
|
**WHAT IT ACTUALLY DOES**:
|
|
135
|
-
1.
|
|
135
|
+
1. Discovers spec layers via `get_context.py --mode packages` and reads relevant guidelines
|
|
136
136
|
2. Loads project-specific patterns into AI's working context:
|
|
137
137
|
- Component naming conventions
|
|
138
138
|
- State management patterns
|
|
@@ -140,12 +140,12 @@ AI models have "pre-trained knowledge" - general patterns from millions of codeb
|
|
|
140
140
|
- Error handling standards
|
|
141
141
|
|
|
142
142
|
**WHY THIS MATTERS**:
|
|
143
|
-
- Without before
|
|
144
|
-
- With before
|
|
143
|
+
- Without before-dev: AI writes generic code that doesn't match project style.
|
|
144
|
+
- With before-dev: AI writes code that looks like the rest of the codebase.
|
|
145
145
|
|
|
146
146
|
---
|
|
147
147
|
|
|
148
|
-
### /trellis-check
|
|
148
|
+
### /trellis-check - Combat Context Drift
|
|
149
149
|
|
|
150
150
|
**WHY IT EXISTS**:
|
|
151
151
|
AI context window has limited capacity. As conversation progresses, guidelines injected at session start become less influential. This causes "context drift."
|
|
@@ -211,9 +211,9 @@ All the context AI built during this session will be lost when session ends. The
|
|
|
211
211
|
|
|
212
212
|
**[1/8] /trellis-start** - AI needs project context before touching code
|
|
213
213
|
**[2/8] python3 ./.trellis/scripts/task.py create "Fix bug" --slug fix-bug** - Track work for future reference
|
|
214
|
-
**[3/8] /trellis-before-
|
|
214
|
+
**[3/8] /trellis-before-dev** - Inject project-specific development guidelines
|
|
215
215
|
**[4/8] Investigate and fix the bug** - Actual development work
|
|
216
|
-
**[5/8] /trellis-check
|
|
216
|
+
**[5/8] /trellis-check** - Re-verify code against guidelines
|
|
217
217
|
**[6/8] /trellis-finish-work** - Holistic cross-layer review
|
|
218
218
|
**[7/8] Human tests and commits** - Human validates before code enters repo
|
|
219
219
|
**[8/8] /trellis-record-session** - Persist memory for future sessions
|
|
@@ -228,9 +228,9 @@ All the context AI built during this session will be lost when session ends. The
|
|
|
228
228
|
### Example 3: Code Review Fixes
|
|
229
229
|
|
|
230
230
|
**[1/6] /trellis-start** - Resume context from previous session
|
|
231
|
-
**[2/6] /trellis-before-
|
|
231
|
+
**[2/6] /trellis-before-dev** - Re-inject guidelines before fixes
|
|
232
232
|
**[3/6] Fix each CR issue** - Address feedback with guidelines in context
|
|
233
|
-
**[4/6] /trellis-check
|
|
233
|
+
**[4/6] /trellis-check** - Verify fixes did not introduce new issues
|
|
234
234
|
**[5/6] /trellis-finish-work** - Document lessons from CR
|
|
235
235
|
**[6/6] Human commits, then /trellis-record-session** - Preserve CR lessons
|
|
236
236
|
|
|
@@ -238,16 +238,16 @@ All the context AI built during this session will be lost when session ends. The
|
|
|
238
238
|
|
|
239
239
|
**[1/5] /trellis-start** - Clear baseline before major changes
|
|
240
240
|
**[2/5] Plan phases** - Break into verifiable chunks
|
|
241
|
-
**[3/5] Execute phase by phase with /check
|
|
241
|
+
**[3/5] Execute phase by phase with /trellis-check after each** - Incremental verification
|
|
242
242
|
**[4/5] /trellis-finish-work** - Check if new patterns should be documented
|
|
243
243
|
**[5/5] Record with multiple commit hashes** - Link all commits to one feature
|
|
244
244
|
|
|
245
245
|
### Example 5: Debug Session
|
|
246
246
|
|
|
247
247
|
**[1/6] /trellis-start** - See if this bug was investigated before
|
|
248
|
-
**[2/6] /trellis-before-
|
|
248
|
+
**[2/6] /trellis-before-dev** - Guidelines might document known gotchas
|
|
249
249
|
**[3/6] Investigation** - Actual debugging work
|
|
250
|
-
**[4/6] /trellis-check
|
|
250
|
+
**[4/6] /trellis-check** - Verify debug changes do not break other things
|
|
251
251
|
**[5/6] /trellis-finish-work** - Debug findings might need documentation
|
|
252
252
|
**[6/6] Human commits, then /trellis-record-session** - Debug knowledge is valuable
|
|
253
253
|
|
|
@@ -256,7 +256,7 @@ All the context AI built during this session will be lost when session ends. The
|
|
|
256
256
|
## KEY RULES TO EMPHASIZE
|
|
257
257
|
|
|
258
258
|
1. **AI NEVER commits** - Human tests and approves. AI prepares, human validates.
|
|
259
|
-
2. **Guidelines before code** - /before
|
|
259
|
+
2. **Guidelines before code** - /before-dev command injects project knowledge.
|
|
260
260
|
3. **Check after code** - /check-* commands catch context drift.
|
|
261
261
|
4. **Record everything** - /trellis-record-session persists memory.
|
|
262
262
|
|
|
@@ -31,7 +31,7 @@ python3 ./.trellis/scripts/add_session.py \
|
|
|
31
31
|
--summary "Brief summary of what was done"
|
|
32
32
|
|
|
33
33
|
# Method 2: Pass detailed content via stdin
|
|
34
|
-
cat << 'EOF' | python3 ./.trellis/scripts/add_session.py --title "Title" --commit "hash"
|
|
34
|
+
cat << 'EOF' | python3 ./.trellis/scripts/add_session.py --stdin --title "Title" --commit "hash"
|
|
35
35
|
| Feature | Description |
|
|
36
36
|
|---------|-------------|
|
|
37
37
|
| New API | Added user authentication endpoint |
|
|
@@ -46,6 +46,7 @@ EOF
|
|
|
46
46
|
**Auto-completes**:
|
|
47
47
|
- [OK] Appends session to journal-N.md
|
|
48
48
|
- [OK] Auto-detects line count, creates new file if >2000 lines
|
|
49
|
+
- [OK] Auto-detects Branch context (`--branch` override; otherwise Branch = task.json -> current git branch; missing values are omitted gracefully)
|
|
49
50
|
- [OK] Updates index.md (Total Sessions +1, Last Active, line stats, history)
|
|
50
51
|
- [OK] Auto-commits .trellis/workspace and .trellis/tasks changes
|
|
51
52
|
|
|
@@ -56,6 +57,6 @@ EOF
|
|
|
56
57
|
| Command | Purpose |
|
|
57
58
|
|---------|---------|
|
|
58
59
|
| `python3 ./.trellis/scripts/get_context.py --mode record` | Get context for record-session |
|
|
59
|
-
| `python3 ./.trellis/scripts/add_session.py --title "..." --commit "..."` | **One-click add session (recommended)** |
|
|
60
|
+
| `python3 ./.trellis/scripts/add_session.py --title "..." --commit "..."` | **One-click add session (recommended, branch auto-complete)** |
|
|
60
61
|
| `python3 ./.trellis/scripts/task.py archive <name>` | Archive completed task (auto-commits) |
|
|
61
62
|
| `python3 ./.trellis/scripts/task.py list` | List active tasks |
|
|
@@ -38,24 +38,17 @@ This returns:
|
|
|
38
38
|
- Active tasks
|
|
39
39
|
- Journal file status
|
|
40
40
|
|
|
41
|
-
### Step 3: Read
|
|
41
|
+
### Step 3: Read Guidelines Index `[AI]`
|
|
42
42
|
|
|
43
|
-
Based on the upcoming task, read appropriate code-spec docs:
|
|
44
|
-
|
|
45
|
-
**For Frontend Work**:
|
|
46
43
|
```bash
|
|
47
|
-
|
|
44
|
+
python3 ./.trellis/scripts/get_context.py --mode packages
|
|
48
45
|
```
|
|
49
46
|
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
cat .trellis/spec/backend/index.md
|
|
53
|
-
```
|
|
47
|
+
This shows available packages and their spec layers. Read the relevant spec indexes:
|
|
54
48
|
|
|
55
|
-
**For Cross-Layer Features**:
|
|
56
49
|
```bash
|
|
57
|
-
cat .trellis/spec
|
|
58
|
-
cat .trellis/spec/guides/
|
|
50
|
+
cat .trellis/spec/<package>/<layer>/index.md # Package-specific guidelines
|
|
51
|
+
cat .trellis/spec/guides/index.md # Thinking guides (always read)
|
|
59
52
|
```
|
|
60
53
|
|
|
61
54
|
> **Important**: The index files are navigation — they list the actual guideline files (e.g., `error-handling.md`, `conventions.md`, `mock-strategies.md`).
|
|
@@ -331,10 +324,8 @@ The following slash commands are for users (not AI):
|
|
|
331
324
|
|---------|-------------|
|
|
332
325
|
| `/trellis-start` | Start development session (this command) |
|
|
333
326
|
| `/trellis-brainstorm` | Clarify vague requirements before implementation |
|
|
334
|
-
| `/trellis-before-
|
|
335
|
-
| `/trellis-
|
|
336
|
-
| `/trellis-check-frontend` | Check frontend code |
|
|
337
|
-
| `/trellis-check-backend` | Check backend code |
|
|
327
|
+
| `/trellis-before-dev` | Read development guidelines |
|
|
328
|
+
| `/trellis-check` | Check code quality |
|
|
338
329
|
| `/trellis-check-cross-layer` | Cross-layer verification |
|
|
339
330
|
| `/trellis-finish-work` | Pre-commit checklist |
|
|
340
331
|
| `/trellis-record-session` | Record session progress |
|
|
@@ -51,6 +51,17 @@ export declare function getIflowTemplatePath(): string;
|
|
|
51
51
|
* @deprecated Use getIflowTemplatePath() instead.
|
|
52
52
|
*/
|
|
53
53
|
export declare function getIflowSourcePath(): string;
|
|
54
|
+
/**
|
|
55
|
+
* Get the path to the Codex templates directory.
|
|
56
|
+
*
|
|
57
|
+
* This reads from src/templates/codex/ (development) or dist/templates/codex/ (production).
|
|
58
|
+
* These are GENERIC templates, not the Trellis project's own .agents/.codex configuration.
|
|
59
|
+
*/
|
|
60
|
+
export declare function getCodexTemplatePath(): string;
|
|
61
|
+
/**
|
|
62
|
+
* @deprecated Use getCodexTemplatePath() instead.
|
|
63
|
+
*/
|
|
64
|
+
export declare function getCodexSourcePath(): string;
|
|
54
65
|
/**
|
|
55
66
|
* Get the path to the kilo templates directory.
|
|
56
67
|
*
|
|
@@ -80,6 +91,17 @@ export declare function getAntigravityTemplatePath(): string;
|
|
|
80
91
|
* @deprecated Use getAntigravityTemplatePath() instead.
|
|
81
92
|
*/
|
|
82
93
|
export declare function getAntigravitySourcePath(): string;
|
|
94
|
+
/**
|
|
95
|
+
* Get the path to the windsurf templates directory.
|
|
96
|
+
*
|
|
97
|
+
* This reads from src/templates/windsurf/ (development) or dist/templates/windsurf/ (production).
|
|
98
|
+
* These are GENERIC templates, not the Trellis project's own .windsurf/workflows configuration.
|
|
99
|
+
*/
|
|
100
|
+
export declare function getWindsurfTemplatePath(): string;
|
|
101
|
+
/**
|
|
102
|
+
* @deprecated Use getWindsurfTemplatePath() instead.
|
|
103
|
+
*/
|
|
104
|
+
export declare function getWindsurfSourcePath(): string;
|
|
83
105
|
/**
|
|
84
106
|
* Get the path to the qoder templates directory.
|
|
85
107
|
*
|
|
@@ -87,6 +109,20 @@ export declare function getAntigravitySourcePath(): string;
|
|
|
87
109
|
* These are GENERIC templates, not the Trellis project's own .qoder/ configuration.
|
|
88
110
|
*/
|
|
89
111
|
export declare function getQoderTemplatePath(): string;
|
|
112
|
+
/**
|
|
113
|
+
* Get the path to the codebuddy templates directory.
|
|
114
|
+
*
|
|
115
|
+
* This reads from src/templates/codebuddy/ (development) or dist/templates/codebuddy/ (production).
|
|
116
|
+
* These are GENERIC templates, not the Trellis project's own .codebuddy/ configuration.
|
|
117
|
+
*/
|
|
118
|
+
export declare function getCodebuddyTemplatePath(): string;
|
|
119
|
+
/**
|
|
120
|
+
* Get the path to the copilot templates directory.
|
|
121
|
+
*
|
|
122
|
+
* This reads from src/templates/copilot/ (development) or dist/templates/copilot/ (production).
|
|
123
|
+
* These are GENERIC templates, not the Trellis project's own .github/copilot/ configuration.
|
|
124
|
+
*/
|
|
125
|
+
export declare function getCopilotTemplatePath(): string;
|
|
90
126
|
/**
|
|
91
127
|
* Read a file from the .trellis directory
|
|
92
128
|
* @param relativePath - Path relative to .trellis/ (e.g., 'scripts/task.py')
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/templates/extract.ts"],"names":[],"mappings":"AAQA,KAAK,gBAAgB,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;AAE5D;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAU/C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,CAShD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAS7C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAS5C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAS5C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,MAAM,CASnD;AAED;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,MAAM,GACf,MAAM,CAGR;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAClC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GACjC,OAAO,CAAC,IAAI,CAAC,CAIf"}
|
|
1
|
+
{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/templates/extract.ts"],"names":[],"mappings":"AAQA,KAAK,gBAAgB,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;AAE5D;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAU/C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,CAShD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAS7C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAS7C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAS5C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAS5C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,MAAM,CASnD;AAED;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,CAShD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAS7C;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CASjD;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAS/C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,MAAM,GACf,MAAM,CAGR;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAClC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GACjC,OAAO,CAAC,IAAI,CAAC,CAIf"}
|