@blxzer/cursor-trellis 0.2.9 → 0.3.0
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/CHANGELOG.md +64 -0
- package/README.md +37 -12
- package/README.zh-CN.md +41 -16
- package/bin/{trellis.js → cstl.js} +1 -1
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +30 -4
- package/dist/cli/index.js.map +1 -1
- package/dist/commands/capability-smoke.d.ts +24 -0
- package/dist/commands/capability-smoke.d.ts.map +1 -0
- package/dist/commands/capability-smoke.js +83 -0
- package/dist/commands/capability-smoke.js.map +1 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +94 -34
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/uninstall.d.ts +1 -1
- package/dist/commands/uninstall.js +2 -2
- package/dist/commands/uninstall.js.map +1 -1
- package/dist/commands/update.d.ts +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +79 -34
- package/dist/commands/update.js.map +1 -1
- package/dist/commands/upgrade.js +2 -2
- package/dist/commands/upgrade.js.map +1 -1
- package/dist/configurators/cursor.d.ts +2 -2
- package/dist/configurators/cursor.js +4 -4
- package/dist/configurators/cursor.js.map +1 -1
- package/dist/configurators/index.js +3 -3
- package/dist/configurators/index.js.map +1 -1
- package/dist/configurators/shared.d.ts +10 -10
- package/dist/configurators/shared.d.ts.map +1 -1
- package/dist/configurators/shared.js +26 -26
- package/dist/configurators/shared.js.map +1 -1
- package/dist/configurators/workflow.d.ts +2 -2
- package/dist/migrations/manifests/0.2.10.json +374 -0
- package/dist/migrations/manifests/0.3.0.json +89 -0
- package/dist/templates/common/bundled-skills/{trellis-cursor2plus-setup → cstl-cursor2plus-setup}/SKILL.md +5 -4
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/SKILL.md +75 -75
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/add-project-local-conventions.md +8 -8
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-agents.md +6 -6
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-context-loading.md +7 -7
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-skills-or-commands.md +1 -1
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-spec-structure.md +2 -2
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-task-lifecycle.md +31 -31
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-workflow.md +12 -12
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/overview.md +55 -55
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/context-injection.md +13 -13
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/generated-files.md +83 -83
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/overview.md +2 -2
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/spec-system.md +1 -1
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/task-system.md +22 -22
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/workflow.md +5 -5
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/local-architecture/workspace-memory.md +3 -3
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/platform-files/agents.md +11 -11
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/platform-files/hooks-and-settings.md +1 -1
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/platform-files/overview.md +4 -4
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/platform-files/platform-map.md +5 -5
- package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/platform-files/skills-and-commands.md +15 -15
- package/dist/templates/common/bundled-skills/{trellis-micro-grill → cstl-micro-grill}/SKILL.md +62 -47
- package/dist/templates/common/bundled-skills/{trellis-skill-creator → cstl-skill-creator}/SKILL.md +44 -44
- package/dist/templates/common/bundled-skills/{trellis-skill-creator → cstl-skill-creator}/references/authoring-rules.md +97 -97
- package/dist/templates/common/bundled-skills/{trellis-skill-creator/references/trellis-skill-locations.md → cstl-skill-creator/references/cstl-skill-locations.md} +52 -52
- package/dist/templates/common/bundled-skills/{trellis-skill-creator → cstl-skill-creator}/references/review-checklist.md +47 -47
- package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/SKILL.md +1 -1
- package/dist/templates/common/commands/continue.md +20 -20
- package/dist/templates/common/commands/start.md +11 -11
- package/dist/templates/common/index.d.ts +1 -1
- package/dist/templates/common/index.d.ts.map +1 -1
- package/dist/templates/common/skills/brainstorm.md +188 -164
- package/dist/templates/common/skills/check.md +1 -1
- package/dist/templates/cursor/agents/{trellis-check.md → cstl-check.md} +8 -8
- package/dist/templates/cursor/agents/{trellis-implement.md → cstl-implement.md} +8 -8
- package/dist/templates/cursor/agents/{trellis-research.md → cstl-research.md} +2 -2
- package/dist/templates/cursor/commands/cursor2plus-setup.md +5 -5
- package/dist/templates/cursor/fixtures/expected-rules.d.ts +1 -1
- package/dist/templates/cursor/fixtures/expected-rules.d.ts.map +1 -1
- package/dist/templates/cursor/fixtures/expected-rules.js +2 -2
- package/dist/templates/cursor/fixtures/expected-rules.js.map +1 -1
- package/dist/templates/cursor/rules/{trellis-subagent-dispatch.mdc → cstl-subagent-dispatch.mdc} +2 -2
- package/dist/templates/cursor/rules/{trellis-triage.mdc → cstl-triage.mdc} +1 -1
- package/dist/templates/markdown/agents.md +4 -4
- package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md.txt +634 -634
- package/dist/templates/markdown/spec/guides/cursor-context-injection-guide.md.txt +4 -4
- package/dist/templates/markdown/spec/guides/cursor-semantic-compliance.md.txt +6 -0
- package/dist/templates/markdown/spec/guides/cursor-subagent-policy.md.txt +393 -391
- package/dist/templates/markdown/spec/guides/durable-learning-decision-guide.md.txt +6 -6
- package/dist/templates/markdown/spec/guides/execution-strategy.md.txt +2 -2
- package/dist/templates/markdown/spec/guides/index.md.txt +3 -2
- package/dist/templates/shared-hooks/index.d.ts +1 -1
- package/dist/templates/shared-hooks/index.js +1 -1
- package/dist/templates/shared-hooks/inject-subagent-context.py +3 -3
- package/dist/templates/shared-hooks/inject-workflow-state.py +27 -27
- package/dist/templates/shared-hooks/research-end-retrieval-pack.py +1 -1
- package/dist/templates/shared-hooks/session-start.py +3 -3
- package/dist/templates/trellis/config/execution-strategy-rules.json +1 -1
- package/dist/templates/trellis/config.yaml +4 -4
- package/dist/templates/trellis/local/README.md +12 -10
- package/dist/templates/trellis/local/patch_wpelc8.py +3 -3
- package/dist/templates/trellis/local/subagent-models.json.example +1 -1
- package/dist/templates/trellis/local/trellis-task-models.json.example +3 -3
- package/dist/templates/trellis/local/trellis-task-models.json5.example +5 -5
- package/dist/templates/trellis/local/trellis_task_models_config.py +6 -6
- package/dist/templates/trellis/scripts/common/cli_adapter.py +3 -3
- package/dist/templates/trellis/scripts/common/execution_strategy.py +1 -1
- package/dist/templates/trellis/scripts/common/parent_orchestration.py +702 -702
- package/dist/templates/trellis/scripts/common/session_context.py +1159 -1159
- package/dist/templates/trellis/scripts/common/subagent_dispatch.py +5 -5
- package/dist/templates/trellis/scripts/common/task_gates.py +2056 -2034
- package/dist/templates/trellis/scripts/common/task_store.py +1594 -1594
- package/dist/templates/trellis/workflow.md +805 -805
- package/dist/types/ai-tools.d.ts +1 -1
- package/dist/types/ai-tools.d.ts.map +1 -1
- package/dist/types/ai-tools.js +1 -1
- package/dist/types/ai-tools.js.map +1 -1
- package/dist/utils/project-capabilities.d.ts +14 -3
- package/dist/utils/project-capabilities.d.ts.map +1 -1
- package/dist/utils/project-capabilities.js +122 -12
- package/dist/utils/project-capabilities.js.map +1 -1
- package/dist/utils/readiness.d.ts +10 -0
- package/dist/utils/readiness.d.ts.map +1 -1
- package/dist/utils/readiness.js +6 -3
- package/dist/utils/readiness.js.map +1 -1
- package/package.json +3 -4
- /package/dist/templates/common/bundled-skills/{trellis-meta → cstl-meta}/references/customize-local/change-hooks.md +0 -0
- /package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/references/mcp-setup.md +0 -0
- /package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/references/repository-analysis.md +0 -0
- /package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/references/spec-task-planning.md +0 -0
- /package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/references/spec-writing.md +0 -0
package/dist/templates/common/bundled-skills/{trellis-micro-grill → cstl-micro-grill}/SKILL.md
RENAMED
|
@@ -1,47 +1,62 @@
|
|
|
1
|
-
---
|
|
2
|
-
name:
|
|
3
|
-
description: "Clarifies small underspecified Trellis requests with one high-value question at a time before direct execution. Use when a request is likely small, missing details would materially change the result, and creating a Trellis task would be premature."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Trellis Micro-Grill
|
|
7
|
-
|
|
8
|
-
## Goal
|
|
9
|
-
|
|
10
|
-
Clarify a small request just enough to execute it directly without creating Trellis task artifacts by default.
|
|
11
|
-
|
|
12
|
-
## Hard Constraints
|
|
13
|
-
|
|
14
|
-
- Always ask exactly one high-value question at a time.
|
|
15
|
-
- Always inspect local files first when the missing answer is discoverable from the project.
|
|
16
|
-
- Always include a recommended answer when enough evidence exists.
|
|
17
|
-
- Always use Simplified Chinese for user-facing questions.
|
|
18
|
-
- Never create Trellis task artifacts by default.
|
|
19
|
-
- Never keep grilling after the request is clear enough to execute.
|
|
20
|
-
- Never repeat already answered questions after escalation.
|
|
21
|
-
|
|
22
|
-
##
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
1
|
+
---
|
|
2
|
+
name: cstl-micro-grill
|
|
3
|
+
description: "Clarifies small underspecified Trellis requests with one high-value question at a time before direct execution. Use when a request is likely small, missing details would materially change the result, and creating a Trellis task would be premature."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Trellis Micro-Grill
|
|
7
|
+
|
|
8
|
+
## Goal
|
|
9
|
+
|
|
10
|
+
Clarify a small request just enough to execute it directly without creating Trellis task artifacts by default.
|
|
11
|
+
|
|
12
|
+
## Hard Constraints
|
|
13
|
+
|
|
14
|
+
- Always ask exactly one high-value question at a time.
|
|
15
|
+
- Always inspect local files first when the missing answer is discoverable from the project.
|
|
16
|
+
- Always include a recommended answer when enough evidence exists.
|
|
17
|
+
- Always use Simplified Chinese for user-facing questions.
|
|
18
|
+
- Never create Trellis task artifacts by default.
|
|
19
|
+
- Never keep grilling after the request is clear enough to execute.
|
|
20
|
+
- Never repeat already answered questions after escalation.
|
|
21
|
+
|
|
22
|
+
## Thinking Principles
|
|
23
|
+
|
|
24
|
+
These two principles shape *which* question is worth asking and *what* to recommend — apply them inside the one-question-per-message contract above.
|
|
25
|
+
|
|
26
|
+
### First Principles
|
|
27
|
+
|
|
28
|
+
Pick the question whose answer most changes the result by tracing the request back to its root user value, not to how similar requests are usually handled.
|
|
29
|
+
|
|
30
|
+
- Separate the **root need** from **inherited shape** ("I want X like Y") — grill the root need first.
|
|
31
|
+
- Prefer the question that, once answered, collapses the most other candidate questions.
|
|
32
|
+
|
|
33
|
+
### Occam's Razor
|
|
34
|
+
|
|
35
|
+
Your recommended answer defaults to the **minimal sufficient** option that still satisfies the likely acceptance bar. Complexity must be justified by evidence you can cite, not added speculatively. If two clarifications are equally valid, recommend the simpler one.
|
|
36
|
+
|
|
37
|
+
## Workflow
|
|
38
|
+
|
|
39
|
+
1. Confirm internally that the request is small, underspecified, and not already covered by a selected Trellis task.
|
|
40
|
+
2. Inspect relevant local context first if it can answer the missing detail.
|
|
41
|
+
3. Ask one question whose answer would most change the result.
|
|
42
|
+
4. Include a recommended answer with the concrete tradeoff.
|
|
43
|
+
5. After the user answers, summarize the clarified requirement in one or two Chinese sentences.
|
|
44
|
+
6. Execute directly once the requirement is clear enough.
|
|
45
|
+
|
|
46
|
+
## Escalation
|
|
47
|
+
|
|
48
|
+
Escalate once when the clarified work no longer fits Micro-Grill:
|
|
49
|
+
|
|
50
|
+
- Use Lite Task when there is one independently verifiable deliverable that needs persistence, review, or continuation.
|
|
51
|
+
- Use Full Task when one deliverable has broad impact, platform-adapter changes, external research dependency, or durable design risk.
|
|
52
|
+
- Use Parent/Child when there are multiple independently verifiable deliverables, staged execution, parallel execution, or Parent-controlled integration needs.
|
|
53
|
+
|
|
54
|
+
When escalating, hand the clarified answers into `cstl-brainstorm` and update Trellis artifacts there.
|
|
55
|
+
|
|
56
|
+
## When NOT to Use
|
|
57
|
+
|
|
58
|
+
- Do not use for multi-deliverable work.
|
|
59
|
+
- Do not use for cross-platform workflow changes.
|
|
60
|
+
- Do not use for risky refactors, migrations, prompt deployments, or durable architecture decisions.
|
|
61
|
+
- Do not use when the request is already clear enough to execute.
|
|
62
|
+
- Do not use when there is already a selected Trellis task for the work.
|
package/dist/templates/common/bundled-skills/{trellis-skill-creator → cstl-skill-creator}/SKILL.md
RENAMED
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
---
|
|
2
|
-
name:
|
|
3
|
-
description: "Create or improve Trellis-compatible agent skills. Use when the user asks to author a project-local skill, shared .agents skill, platform-specific skill, or upstream Trellis bundled skill."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Trellis Skill Creator
|
|
7
|
-
|
|
8
|
-
Create high-quality skills for Trellis-managed projects and Trellis bundled templates.
|
|
9
|
-
|
|
10
|
-
This skill is the authoring and review guide for skill files. It is not the local Trellis architecture map. Use `
|
|
11
|
-
|
|
12
|
-
## Hard Constraints
|
|
13
|
-
|
|
14
|
-
- Always inspect existing skill directories and platform conventions before creating or changing a skill.
|
|
15
|
-
- Always keep `SKILL.md` short, English-language, and focused on trigger, constraints, workflow, references, and boundaries.
|
|
16
|
-
- Always use lowercase letters, numbers, and hyphens in the frontmatter `name`.
|
|
17
|
-
- Always write a trigger-rich frontmatter `description` that states what the skill does and when it should trigger.
|
|
18
|
-
- Always place safety, sequencing, and reliability rules in a `## Hard Constraints` section before `## Workflow`.
|
|
19
|
-
- Always move long guidance, examples, prompts, and reference material into directly linked files.
|
|
20
|
-
- Always make helper scripts deterministic, runnable from the skill directory, and explicit about inputs and outputs.
|
|
21
|
-
- Never duplicate `
|
|
22
|
-
- Never edit Cursor's built-in `create-skill`; create or update Trellis-compatible skill files instead.
|
|
23
|
-
|
|
24
|
-
## Workflow
|
|
25
|
-
|
|
26
|
-
1. Classify the target skill location and read `references/
|
|
27
|
-
2. Gather the skill purpose, trigger scenarios, target users, required tools, output shape, and existing local patterns.
|
|
28
|
-
3. Draft or revise `SKILL.md` using `references/authoring-rules.md`.
|
|
29
|
-
4. Add `references/`, `examples/`, `prompts/`, or `scripts/` only when they reduce entry-file size or make execution more deterministic.
|
|
30
|
-
5. Verify the result with `references/review-checklist.md`.
|
|
31
|
-
6. Report changed files, validation performed, and any boundaries or follow-up work.
|
|
32
|
-
|
|
33
|
-
## References
|
|
34
|
-
|
|
35
|
-
- `references/
|
|
36
|
-
- `references/authoring-rules.md`: Frontmatter, trigger descriptions, hard constraints, progressive disclosure, deterministic scripts, and anti-patterns.
|
|
37
|
-
- `references/review-checklist.md`: Final quality checklist before handing off a skill change.
|
|
38
|
-
|
|
39
|
-
## When NOT To Use
|
|
40
|
-
|
|
41
|
-
- Do not use for general Trellis architecture discovery; use `
|
|
42
|
-
- Do not use for project coding conventions that belong in `.trellis/spec/`.
|
|
43
|
-
- Do not use for one-off commands or prompts unless the user wants a durable auto-triggered capability.
|
|
44
|
-
- Do not use for non-Trellis global skill installation or platform configuration unless the user explicitly asks for that scope.
|
|
1
|
+
---
|
|
2
|
+
name: cstl-skill-creator
|
|
3
|
+
description: "Create or improve Trellis-compatible agent skills. Use when the user asks to author a project-local skill, shared .agents skill, platform-specific skill, or upstream Trellis bundled skill."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Trellis Skill Creator
|
|
7
|
+
|
|
8
|
+
Create high-quality skills for Trellis-managed projects and Trellis bundled templates.
|
|
9
|
+
|
|
10
|
+
This skill is the authoring and review guide for skill files. It is not the local Trellis architecture map. Use `cstl-meta` first when the user needs to understand or customize `.trellis/`, hooks, settings, commands, prompts, workflows, agents, or platform directory layout.
|
|
11
|
+
|
|
12
|
+
## Hard Constraints
|
|
13
|
+
|
|
14
|
+
- Always inspect existing skill directories and platform conventions before creating or changing a skill.
|
|
15
|
+
- Always keep `SKILL.md` short, English-language, and focused on trigger, constraints, workflow, references, and boundaries.
|
|
16
|
+
- Always use lowercase letters, numbers, and hyphens in the frontmatter `name`.
|
|
17
|
+
- Always write a trigger-rich frontmatter `description` that states what the skill does and when it should trigger.
|
|
18
|
+
- Always place safety, sequencing, and reliability rules in a `## Hard Constraints` section before `## Workflow`.
|
|
19
|
+
- Always move long guidance, examples, prompts, and reference material into directly linked files.
|
|
20
|
+
- Always make helper scripts deterministic, runnable from the skill directory, and explicit about inputs and outputs.
|
|
21
|
+
- Never duplicate `cstl-meta` architecture guidance or project-private conventions inside a public Trellis skill.
|
|
22
|
+
- Never edit Cursor's built-in `create-skill`; create or update Trellis-compatible skill files instead.
|
|
23
|
+
|
|
24
|
+
## Workflow
|
|
25
|
+
|
|
26
|
+
1. Classify the target skill location and read `references/cstl-skill-locations.md`.
|
|
27
|
+
2. Gather the skill purpose, trigger scenarios, target users, required tools, output shape, and existing local patterns.
|
|
28
|
+
3. Draft or revise `SKILL.md` using `references/authoring-rules.md`.
|
|
29
|
+
4. Add `references/`, `examples/`, `prompts/`, or `scripts/` only when they reduce entry-file size or make execution more deterministic.
|
|
30
|
+
5. Verify the result with `references/review-checklist.md`.
|
|
31
|
+
6. Report changed files, validation performed, and any boundaries or follow-up work.
|
|
32
|
+
|
|
33
|
+
## References
|
|
34
|
+
|
|
35
|
+
- `references/cstl-skill-locations.md`: Choose project-local, shared, platform-specific, or upstream bundled skill locations.
|
|
36
|
+
- `references/authoring-rules.md`: Frontmatter, trigger descriptions, hard constraints, progressive disclosure, deterministic scripts, and anti-patterns.
|
|
37
|
+
- `references/review-checklist.md`: Final quality checklist before handing off a skill change.
|
|
38
|
+
|
|
39
|
+
## When NOT To Use
|
|
40
|
+
|
|
41
|
+
- Do not use for general Trellis architecture discovery; use `cstl-meta`.
|
|
42
|
+
- Do not use for project coding conventions that belong in `.trellis/spec/`.
|
|
43
|
+
- Do not use for one-off commands or prompts unless the user wants a durable auto-triggered capability.
|
|
44
|
+
- Do not use for non-Trellis global skill installation or platform configuration unless the user explicitly asks for that scope.
|
|
@@ -1,97 +1,97 @@
|
|
|
1
|
-
# Skill Authoring Rules
|
|
2
|
-
|
|
3
|
-
Use these rules when creating or reviewing a Trellis-compatible skill.
|
|
4
|
-
|
|
5
|
-
## Required Shape
|
|
6
|
-
|
|
7
|
-
Every active skill directory needs a `SKILL.md` with YAML frontmatter:
|
|
8
|
-
|
|
9
|
-
```markdown
|
|
10
|
-
---
|
|
11
|
-
name: skill-name
|
|
12
|
-
description: Specific capability and trigger scenarios.
|
|
13
|
-
---
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
Rules:
|
|
17
|
-
|
|
18
|
-
- Use lowercase letters, numbers, and hyphens in `name`.
|
|
19
|
-
- Write `description` in third person because platforms inject it into tool or skill discovery prompts.
|
|
20
|
-
- Include both what the skill does and when it should trigger.
|
|
21
|
-
- Keep `SKILL.md` under 500 lines and usually far shorter.
|
|
22
|
-
- Keep `SKILL.md` in English unless the target platform or user explicitly requires another language.
|
|
23
|
-
|
|
24
|
-
## Description Quality
|
|
25
|
-
|
|
26
|
-
The description is the trigger surface. It should contain concrete task nouns and user-intent phrases.
|
|
27
|
-
|
|
28
|
-
Good:
|
|
29
|
-
|
|
30
|
-
```yaml
|
|
31
|
-
description: "Create or improve Trellis-compatible agent skills. Use when the user asks to author a project-local skill, shared .agents skill, platform-specific skill, or upstream Trellis bundled skill."
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
Avoid:
|
|
35
|
-
|
|
36
|
-
```yaml
|
|
37
|
-
description: "Helps with skills."
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Checklist:
|
|
41
|
-
|
|
42
|
-
- Names the capability.
|
|
43
|
-
- Names common trigger situations.
|
|
44
|
-
- Avoids first person.
|
|
45
|
-
- Avoids broad utility wording such as "helper", "tools", or "useful".
|
|
46
|
-
- Does not claim support for platforms or files the skill does not cover.
|
|
47
|
-
|
|
48
|
-
## Hard Constraints
|
|
49
|
-
|
|
50
|
-
Put a `## Hard Constraints` section near the top, before `## Workflow`, when the skill has safety, sequencing, scope, or reliability rules.
|
|
51
|
-
|
|
52
|
-
Write constraints as imperative one-liners:
|
|
53
|
-
|
|
54
|
-
- Always inspect local files before editing.
|
|
55
|
-
- Never modify global configuration without explicit user approval.
|
|
56
|
-
- Always run the validator before final output.
|
|
57
|
-
|
|
58
|
-
Do not bury constraints in paragraphs. Do not repeat the same rule in another section; make Hard Constraints the single source of truth.
|
|
59
|
-
|
|
60
|
-
## Progressive Disclosure
|
|
61
|
-
|
|
62
|
-
`SKILL.md` should route, not carry every detail.
|
|
63
|
-
|
|
64
|
-
Good candidates for references:
|
|
65
|
-
|
|
66
|
-
- Detailed authoring rules.
|
|
67
|
-
- Domain background.
|
|
68
|
-
- Long examples.
|
|
69
|
-
- Output templates.
|
|
70
|
-
- Platform-specific notes.
|
|
71
|
-
- Review checklists.
|
|
72
|
-
|
|
73
|
-
Keep references one level deep and link them directly from `SKILL.md`. Avoid reference chains where one reference requires reading another reference before it is useful.
|
|
74
|
-
|
|
75
|
-
## Deterministic Scripts
|
|
76
|
-
|
|
77
|
-
Add scripts only when they make the skill more reliable than generated ad hoc code.
|
|
78
|
-
|
|
79
|
-
Script rules:
|
|
80
|
-
|
|
81
|
-
- Put scripts under the owning skill directory, usually `scripts/`.
|
|
82
|
-
- Expose only parameters the agent must supply.
|
|
83
|
-
- Let the script decide internal paths, timestamps, defaults, and output filenames when possible.
|
|
84
|
-
- Return structured JSON to stdout when the script mutates files or produces machine-readable status.
|
|
85
|
-
- State whether the agent should execute the script or read it as reference.
|
|
86
|
-
- Avoid shell variables or cross-step state that would not survive separate tool calls.
|
|
87
|
-
|
|
88
|
-
## Common Anti-Patterns
|
|
89
|
-
|
|
90
|
-
- Vague frontmatter descriptions that can trigger on unrelated work.
|
|
91
|
-
- A single skill that mixes unrelated workflows.
|
|
92
|
-
- `SKILL.md` files that paste long prompts or full scripts instead of linking references.
|
|
93
|
-
- Rules repeated in several sections with slightly different wording.
|
|
94
|
-
- Missing stop conditions for broad search or expensive loops.
|
|
95
|
-
- Commands that rely on shell variables set by a previous tool call.
|
|
96
|
-
- References to files, scripts, or examples that do not exist.
|
|
97
|
-
- Project-private conventions added to public Trellis bundled skills.
|
|
1
|
+
# Skill Authoring Rules
|
|
2
|
+
|
|
3
|
+
Use these rules when creating or reviewing a Trellis-compatible skill.
|
|
4
|
+
|
|
5
|
+
## Required Shape
|
|
6
|
+
|
|
7
|
+
Every active skill directory needs a `SKILL.md` with YAML frontmatter:
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
name: skill-name
|
|
12
|
+
description: Specific capability and trigger scenarios.
|
|
13
|
+
---
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Rules:
|
|
17
|
+
|
|
18
|
+
- Use lowercase letters, numbers, and hyphens in `name`.
|
|
19
|
+
- Write `description` in third person because platforms inject it into tool or skill discovery prompts.
|
|
20
|
+
- Include both what the skill does and when it should trigger.
|
|
21
|
+
- Keep `SKILL.md` under 500 lines and usually far shorter.
|
|
22
|
+
- Keep `SKILL.md` in English unless the target platform or user explicitly requires another language.
|
|
23
|
+
|
|
24
|
+
## Description Quality
|
|
25
|
+
|
|
26
|
+
The description is the trigger surface. It should contain concrete task nouns and user-intent phrases.
|
|
27
|
+
|
|
28
|
+
Good:
|
|
29
|
+
|
|
30
|
+
```yaml
|
|
31
|
+
description: "Create or improve Trellis-compatible agent skills. Use when the user asks to author a project-local skill, shared .agents skill, platform-specific skill, or upstream Trellis bundled skill."
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Avoid:
|
|
35
|
+
|
|
36
|
+
```yaml
|
|
37
|
+
description: "Helps with skills."
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Checklist:
|
|
41
|
+
|
|
42
|
+
- Names the capability.
|
|
43
|
+
- Names common trigger situations.
|
|
44
|
+
- Avoids first person.
|
|
45
|
+
- Avoids broad utility wording such as "helper", "tools", or "useful".
|
|
46
|
+
- Does not claim support for platforms or files the skill does not cover.
|
|
47
|
+
|
|
48
|
+
## Hard Constraints
|
|
49
|
+
|
|
50
|
+
Put a `## Hard Constraints` section near the top, before `## Workflow`, when the skill has safety, sequencing, scope, or reliability rules.
|
|
51
|
+
|
|
52
|
+
Write constraints as imperative one-liners:
|
|
53
|
+
|
|
54
|
+
- Always inspect local files before editing.
|
|
55
|
+
- Never modify global configuration without explicit user approval.
|
|
56
|
+
- Always run the validator before final output.
|
|
57
|
+
|
|
58
|
+
Do not bury constraints in paragraphs. Do not repeat the same rule in another section; make Hard Constraints the single source of truth.
|
|
59
|
+
|
|
60
|
+
## Progressive Disclosure
|
|
61
|
+
|
|
62
|
+
`SKILL.md` should route, not carry every detail.
|
|
63
|
+
|
|
64
|
+
Good candidates for references:
|
|
65
|
+
|
|
66
|
+
- Detailed authoring rules.
|
|
67
|
+
- Domain background.
|
|
68
|
+
- Long examples.
|
|
69
|
+
- Output templates.
|
|
70
|
+
- Platform-specific notes.
|
|
71
|
+
- Review checklists.
|
|
72
|
+
|
|
73
|
+
Keep references one level deep and link them directly from `SKILL.md`. Avoid reference chains where one reference requires reading another reference before it is useful.
|
|
74
|
+
|
|
75
|
+
## Deterministic Scripts
|
|
76
|
+
|
|
77
|
+
Add scripts only when they make the skill more reliable than generated ad hoc code.
|
|
78
|
+
|
|
79
|
+
Script rules:
|
|
80
|
+
|
|
81
|
+
- Put scripts under the owning skill directory, usually `scripts/`.
|
|
82
|
+
- Expose only parameters the agent must supply.
|
|
83
|
+
- Let the script decide internal paths, timestamps, defaults, and output filenames when possible.
|
|
84
|
+
- Return structured JSON to stdout when the script mutates files or produces machine-readable status.
|
|
85
|
+
- State whether the agent should execute the script or read it as reference.
|
|
86
|
+
- Avoid shell variables or cross-step state that would not survive separate tool calls.
|
|
87
|
+
|
|
88
|
+
## Common Anti-Patterns
|
|
89
|
+
|
|
90
|
+
- Vague frontmatter descriptions that can trigger on unrelated work.
|
|
91
|
+
- A single skill that mixes unrelated workflows.
|
|
92
|
+
- `SKILL.md` files that paste long prompts or full scripts instead of linking references.
|
|
93
|
+
- Rules repeated in several sections with slightly different wording.
|
|
94
|
+
- Missing stop conditions for broad search or expensive loops.
|
|
95
|
+
- Commands that rely on shell variables set by a previous tool call.
|
|
96
|
+
- References to files, scripts, or examples that do not exist.
|
|
97
|
+
- Project-private conventions added to public Trellis bundled skills.
|
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
# Trellis Skill Locations
|
|
2
|
-
|
|
3
|
-
Choose the target directory before writing content. Local files are authoritative when they already exist.
|
|
4
|
-
|
|
5
|
-
## Location Decision Table
|
|
6
|
-
|
|
7
|
-
| User goal | Default location | Notes |
|
|
8
|
-
| --- | --- | --- |
|
|
9
|
-
| Add a skill for one Trellis project on Cursor | `.cursor/skills/<skill-name>/` | Default target — Trellis is Cursor-only. |
|
|
10
|
-
| Add a skill shared across tools that read the agentskills.io convention | `.agents/skills/<skill-name>/` | Use only when explicitly sharing with a non-Trellis tool that reads the shared agentskills layer. New Trellis behavior stays in `.cursor/skills/`. |
|
|
11
|
-
| Change an existing local Trellis skill | The existing skill directory in the user's project | Preserve local customizations and read the current `SKILL.md` first. |
|
|
12
|
-
| Add a public Trellis bundled skill | `packages/cli/src/templates/common/bundled-skills/<skill-name>/` | Only when working in the Trellis source repository. Update tests that assert bundled skill installation and template tracking. |
|
|
13
|
-
| Add a personal cross-project skill | User's configured global skills directory | Requires explicit user approval because it changes global behavior outside the project. |
|
|
14
|
-
|
|
15
|
-
## Relationship To `
|
|
16
|
-
|
|
17
|
-
Use `
|
|
18
|
-
|
|
19
|
-
Use `
|
|
20
|
-
|
|
21
|
-
- frontmatter quality
|
|
22
|
-
- trigger descriptions
|
|
23
|
-
- hard constraints
|
|
24
|
-
- workflow shape
|
|
25
|
-
- references
|
|
26
|
-
- examples
|
|
27
|
-
- deterministic scripts
|
|
28
|
-
- final quality review
|
|
29
|
-
|
|
30
|
-
Do not copy the full skill-writing guide into `
|
|
31
|
-
|
|
32
|
-
## Relationship To Cursor `create-skill`
|
|
33
|
-
|
|
34
|
-
Cursor may provide its own built-in `create-skill` helper. Treat it as a platform-owned helper, not as Trellis source material to edit.
|
|
35
|
-
|
|
36
|
-
For Trellis work:
|
|
37
|
-
|
|
38
|
-
- Use `
|
|
39
|
-
- Keep the skill name `
|
|
40
|
-
- If a user explicitly asks for Cursor-only behavior, write to the local `.cursor/skills/` directory and follow the platform's current file format.
|
|
41
|
-
|
|
42
|
-
## Upstream Bundled Skill Notes
|
|
43
|
-
|
|
44
|
-
When adding or modifying a bundled skill in the Trellis source repository:
|
|
45
|
-
|
|
46
|
-
- Do not edit `dist/` directly.
|
|
47
|
-
- Keep the bundled skill public and project-agnostic.
|
|
48
|
-
- Put the skill under `packages/cli/src/templates/common/bundled-skills/`.
|
|
49
|
-
- Include a short `SKILL.md` and lazy-loadable references when the guidance is long.
|
|
50
|
-
- Search for hard-coded bundled skill lists or tests before editing.
|
|
51
|
-
- Update `
|
|
52
|
-
- Validate template collection, platform installation, and hash tracking with focused tests.
|
|
1
|
+
# Trellis Skill Locations
|
|
2
|
+
|
|
3
|
+
Choose the target directory before writing content. Local files are authoritative when they already exist.
|
|
4
|
+
|
|
5
|
+
## Location Decision Table
|
|
6
|
+
|
|
7
|
+
| User goal | Default location | Notes |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| Add a skill for one Trellis project on Cursor | `.cursor/skills/<skill-name>/` | Default target — Trellis is Cursor-only. |
|
|
10
|
+
| Add a skill shared across tools that read the agentskills.io convention | `.agents/skills/<skill-name>/` | Use only when explicitly sharing with a non-Trellis tool that reads the shared agentskills layer. New Trellis behavior stays in `.cursor/skills/`. |
|
|
11
|
+
| Change an existing local Trellis skill | The existing skill directory in the user's project | Preserve local customizations and read the current `SKILL.md` first. |
|
|
12
|
+
| Add a public Trellis bundled skill | `packages/cli/src/templates/common/bundled-skills/<skill-name>/` | Only when working in the Trellis source repository. Update tests that assert bundled skill installation and template tracking. |
|
|
13
|
+
| Add a personal cross-project skill | User's configured global skills directory | Requires explicit user approval because it changes global behavior outside the project. |
|
|
14
|
+
|
|
15
|
+
## Relationship To `cstl-meta`
|
|
16
|
+
|
|
17
|
+
Use `cstl-meta` to understand where local Trellis files live and which platform entry point should be changed.
|
|
18
|
+
|
|
19
|
+
Use `cstl-skill-creator` after the task is clearly about authoring or reviewing the content of a skill:
|
|
20
|
+
|
|
21
|
+
- frontmatter quality
|
|
22
|
+
- trigger descriptions
|
|
23
|
+
- hard constraints
|
|
24
|
+
- workflow shape
|
|
25
|
+
- references
|
|
26
|
+
- examples
|
|
27
|
+
- deterministic scripts
|
|
28
|
+
- final quality review
|
|
29
|
+
|
|
30
|
+
Do not copy the full skill-writing guide into `cstl-meta`. `cstl-meta` should route to this skill for detailed authoring guidance.
|
|
31
|
+
|
|
32
|
+
## Relationship To Cursor `create-skill`
|
|
33
|
+
|
|
34
|
+
Cursor may provide its own built-in `create-skill` helper. Treat it as a platform-owned helper, not as Trellis source material to edit.
|
|
35
|
+
|
|
36
|
+
For Trellis work:
|
|
37
|
+
|
|
38
|
+
- Use `cstl-skill-creator` for Trellis-compatible content and multi-platform boundaries.
|
|
39
|
+
- Keep the skill name `cstl-skill-creator` to avoid colliding with Cursor's built-in skill.
|
|
40
|
+
- If a user explicitly asks for Cursor-only behavior, write to the local `.cursor/skills/` directory and follow the platform's current file format.
|
|
41
|
+
|
|
42
|
+
## Upstream Bundled Skill Notes
|
|
43
|
+
|
|
44
|
+
When adding or modifying a bundled skill in the Trellis source repository:
|
|
45
|
+
|
|
46
|
+
- Do not edit `dist/` directly.
|
|
47
|
+
- Keep the bundled skill public and project-agnostic.
|
|
48
|
+
- Put the skill under `packages/cli/src/templates/common/bundled-skills/`.
|
|
49
|
+
- Include a short `SKILL.md` and lazy-loadable references when the guidance is long.
|
|
50
|
+
- Search for hard-coded bundled skill lists or tests before editing.
|
|
51
|
+
- Update `cstl-meta` only to route users to the new skill where appropriate.
|
|
52
|
+
- Validate template collection, platform installation, and hash tracking with focused tests.
|
|
@@ -1,47 +1,47 @@
|
|
|
1
|
-
# Skill Review Checklist
|
|
2
|
-
|
|
3
|
-
Use this checklist before handing off a new or modified skill.
|
|
4
|
-
|
|
5
|
-
## Frontmatter
|
|
6
|
-
|
|
7
|
-
- [ ] `name` uses lowercase letters, numbers, and hyphens only.
|
|
8
|
-
- [ ] `description` is third-person and trigger-rich.
|
|
9
|
-
- [ ] `description` includes both what the skill does and when to use it.
|
|
10
|
-
- [ ] The skill name does not collide with a platform built-in helper unless that is intentional.
|
|
11
|
-
|
|
12
|
-
## Scope And Boundaries
|
|
13
|
-
|
|
14
|
-
- [ ] The skill owns one coherent workflow.
|
|
15
|
-
- [ ] `When NOT To Use` or equivalent boundary guidance is present when triggers may overlap.
|
|
16
|
-
- [ ] Project-private rules are in `.trellis/spec/` or a project-local skill, not in a public bundled skill.
|
|
17
|
-
- [ ] The skill distinguishes local project customization from upstream Trellis source changes.
|
|
18
|
-
|
|
19
|
-
## Entry File
|
|
20
|
-
|
|
21
|
-
- [ ] `SKILL.md` is concise and under 500 lines.
|
|
22
|
-
- [ ] `SKILL.md` contains the minimum routing and workflow needed to start.
|
|
23
|
-
- [ ] `## Hard Constraints` appears before `## Workflow` when constraints exist.
|
|
24
|
-
- [ ] Hard constraints are imperative one-liners.
|
|
25
|
-
- [ ] The same rule is not repeated in multiple sections.
|
|
26
|
-
|
|
27
|
-
## References And Assets
|
|
28
|
-
|
|
29
|
-
- [ ] Long guidance lives in directly linked reference files.
|
|
30
|
-
- [ ] Every referenced file, script, prompt, or example exists.
|
|
31
|
-
- [ ] Reference paths are relative to the skill directory.
|
|
32
|
-
- [ ] Examples demonstrate a complete workflow boundary, not just a fragment.
|
|
33
|
-
|
|
34
|
-
## Scripts
|
|
35
|
-
|
|
36
|
-
- [ ] Scripts are necessary for determinism, not decorative.
|
|
37
|
-
- [ ] Scripts expose only necessary parameters.
|
|
38
|
-
- [ ] Scripts do not rely on shell variables or state from a previous tool call.
|
|
39
|
-
- [ ] Scripts return structured JSON when they mutate files or provide machine-readable status.
|
|
40
|
-
- [ ] Syntax checks were run for modified scripts when applicable.
|
|
41
|
-
|
|
42
|
-
## Trellis Template Integration
|
|
43
|
-
|
|
44
|
-
- [ ] Bundled skills live under `packages/cli/src/templates/common/bundled-skills/`.
|
|
45
|
-
- [ ] Tests or structured checks confirm platform skill installation and template hash tracking where relevant.
|
|
46
|
-
- [ ] `
|
|
47
|
-
- [ ] `dist/` was not edited as source.
|
|
1
|
+
# Skill Review Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist before handing off a new or modified skill.
|
|
4
|
+
|
|
5
|
+
## Frontmatter
|
|
6
|
+
|
|
7
|
+
- [ ] `name` uses lowercase letters, numbers, and hyphens only.
|
|
8
|
+
- [ ] `description` is third-person and trigger-rich.
|
|
9
|
+
- [ ] `description` includes both what the skill does and when to use it.
|
|
10
|
+
- [ ] The skill name does not collide with a platform built-in helper unless that is intentional.
|
|
11
|
+
|
|
12
|
+
## Scope And Boundaries
|
|
13
|
+
|
|
14
|
+
- [ ] The skill owns one coherent workflow.
|
|
15
|
+
- [ ] `When NOT To Use` or equivalent boundary guidance is present when triggers may overlap.
|
|
16
|
+
- [ ] Project-private rules are in `.trellis/spec/` or a project-local skill, not in a public bundled skill.
|
|
17
|
+
- [ ] The skill distinguishes local project customization from upstream Trellis source changes.
|
|
18
|
+
|
|
19
|
+
## Entry File
|
|
20
|
+
|
|
21
|
+
- [ ] `SKILL.md` is concise and under 500 lines.
|
|
22
|
+
- [ ] `SKILL.md` contains the minimum routing and workflow needed to start.
|
|
23
|
+
- [ ] `## Hard Constraints` appears before `## Workflow` when constraints exist.
|
|
24
|
+
- [ ] Hard constraints are imperative one-liners.
|
|
25
|
+
- [ ] The same rule is not repeated in multiple sections.
|
|
26
|
+
|
|
27
|
+
## References And Assets
|
|
28
|
+
|
|
29
|
+
- [ ] Long guidance lives in directly linked reference files.
|
|
30
|
+
- [ ] Every referenced file, script, prompt, or example exists.
|
|
31
|
+
- [ ] Reference paths are relative to the skill directory.
|
|
32
|
+
- [ ] Examples demonstrate a complete workflow boundary, not just a fragment.
|
|
33
|
+
|
|
34
|
+
## Scripts
|
|
35
|
+
|
|
36
|
+
- [ ] Scripts are necessary for determinism, not decorative.
|
|
37
|
+
- [ ] Scripts expose only necessary parameters.
|
|
38
|
+
- [ ] Scripts do not rely on shell variables or state from a previous tool call.
|
|
39
|
+
- [ ] Scripts return structured JSON when they mutate files or provide machine-readable status.
|
|
40
|
+
- [ ] Syntax checks were run for modified scripts when applicable.
|
|
41
|
+
|
|
42
|
+
## Trellis Template Integration
|
|
43
|
+
|
|
44
|
+
- [ ] Bundled skills live under `packages/cli/src/templates/common/bundled-skills/`.
|
|
45
|
+
- [ ] Tests or structured checks confirm platform skill installation and template hash tracking where relevant.
|
|
46
|
+
- [ ] `cstl-meta` references route to this skill where useful without duplicating full authoring rules.
|
|
47
|
+
- [ ] `dist/` was not edited as source.
|
package/dist/templates/common/bundled-skills/{trellis-spec-bootstrap → cstl-spec-bootstrap}/SKILL.md
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
2
|
+
name: cstl-spec-bootstrap
|
|
3
3
|
description: "Bootstrap project-specific Trellis coding specs with a platform-neutral single-agent workflow. Use when creating or refreshing .trellis/spec guidelines, analyzing a codebase with GitNexus, ABCoder, or source inspection, decomposing package/layer spec work, and writing real codebase-backed spec docs without placeholder text."
|
|
4
4
|
---
|
|
5
5
|
|