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
+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.
|
||||
Reference in New Issue
Block a user