@blxzer/cursor-trellis 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +124 -5
- package/README.zh-CN.md +170 -0
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +1 -33
- package/dist/cli/index.js.map +1 -1
- package/dist/commands/init.d.ts +0 -13
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +7 -14
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/uninstall.d.ts.map +1 -1
- package/dist/commands/uninstall.js +3 -32
- package/dist/commands/uninstall.js.map +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +7 -84
- package/dist/commands/update.js.map +1 -1
- package/dist/configurators/index.d.ts +7 -8
- package/dist/configurators/index.d.ts.map +1 -1
- package/dist/configurators/index.js +11 -236
- package/dist/configurators/index.js.map +1 -1
- package/dist/configurators/workflow.d.ts.map +1 -1
- package/dist/configurators/workflow.js +5 -1
- package/dist/configurators/workflow.js.map +1 -1
- package/dist/templates/common/bundled-skills/smart-search-cli/SKILL.md +3 -3
- package/dist/templates/common/bundled-skills/trellis-meta/SKILL.md +4 -2
- package/dist/templates/common/bundled-skills/trellis-meta/references/customize-local/change-agents.md +8 -15
- package/dist/templates/common/bundled-skills/trellis-meta/references/customize-local/change-hooks.md +7 -7
- package/dist/templates/common/bundled-skills/trellis-meta/references/customize-local/change-skills-or-commands.md +18 -21
- package/dist/templates/common/bundled-skills/trellis-meta/references/customize-local/overview.md +2 -2
- package/dist/templates/common/bundled-skills/trellis-meta/references/local-architecture/generated-files.md +10 -7
- package/dist/templates/common/bundled-skills/trellis-meta/references/local-architecture/overview.md +4 -4
- package/dist/templates/common/bundled-skills/trellis-meta/references/platform-files/agents.md +20 -31
- package/dist/templates/common/bundled-skills/trellis-meta/references/platform-files/hooks-and-settings.md +20 -31
- package/dist/templates/common/bundled-skills/trellis-meta/references/platform-files/overview.md +24 -40
- package/dist/templates/common/bundled-skills/trellis-meta/references/platform-files/platform-map.md +28 -59
- package/dist/templates/common/bundled-skills/trellis-meta/references/platform-files/skills-and-commands.md +12 -28
- package/dist/templates/common/bundled-skills/trellis-skill-creator/references/trellis-skill-locations.md +2 -2
- package/dist/templates/cursor/hooks.json +6 -0
- package/dist/templates/cursor/rules/retrieval-routing.mdc +57 -0
- package/dist/templates/extract.d.ts +0 -14
- package/dist/templates/extract.d.ts.map +1 -1
- package/dist/templates/extract.js +0 -34
- package/dist/templates/extract.js.map +1 -1
- package/dist/templates/markdown/agents.md +2 -6
- package/dist/templates/markdown/index.d.ts +1 -0
- package/dist/templates/markdown/index.d.ts.map +1 -1
- package/dist/templates/markdown/index.js +1 -0
- package/dist/templates/markdown/index.js.map +1 -1
- package/dist/templates/markdown/prompts/run-semantic-slice-12.md.txt +41 -0
- package/dist/templates/markdown/spec/guides/code-reuse-thinking-guide.md.txt +14 -14
- package/dist/templates/markdown/spec/guides/cross-layer-thinking-guide.md.txt +8 -20
- package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md.txt +15 -14
- package/dist/templates/markdown/spec/guides/cursor-context-injection-guide.md.txt +2 -1
- package/dist/templates/markdown/spec/guides/cursor-semantic-compliance.md.txt +49 -0
- package/dist/templates/markdown/spec/guides/cursor-subagent-policy.md.txt +2 -2
- package/dist/templates/markdown/spec/guides/retrieval-daily-guide.md.txt +68 -20
- package/dist/templates/shared-hooks/index.d.ts +1 -1
- package/dist/templates/shared-hooks/index.d.ts.map +1 -1
- package/dist/templates/shared-hooks/index.js +1 -0
- package/dist/templates/shared-hooks/index.js.map +1 -1
- package/dist/templates/shared-hooks/inject-retrieval-plan.py +163 -0
- package/dist/templates/shared-hooks/research-end-retrieval-pack.py +2 -11
- package/dist/templates/trellis/index.d.ts +11 -0
- package/dist/templates/trellis/index.d.ts.map +1 -1
- package/dist/templates/trellis/index.js +22 -0
- package/dist/templates/trellis/index.js.map +1 -1
- package/dist/templates/trellis/scripts/aggregate_retrieval_telemetry.py +342 -0
- package/dist/templates/trellis/scripts/batch_plan_envelope.py +105 -0
- package/dist/templates/trellis/scripts/codegraph_session_smoke.py +76 -0
- package/dist/templates/trellis/scripts/common/active_task.py +116 -147
- package/dist/templates/trellis/scripts/common/cli_adapter.py +34 -710
- package/dist/templates/trellis/scripts/common/codebase_retrieval_router.py +49 -106
- package/dist/templates/trellis/scripts/common/git_context.py +17 -2
- package/dist/templates/trellis/scripts/common/project_file_stats.py +91 -0
- package/dist/templates/trellis/scripts/common/retrieval_adapter_metadata.py +9 -11
- package/dist/templates/trellis/scripts/common/retrieval_agent_instructions.py +313 -0
- package/dist/templates/trellis/scripts/common/retrieval_pack.py +0 -6
- package/dist/templates/trellis/scripts/common/retrieval_pack_context.py +0 -4
- package/dist/templates/trellis/scripts/common/retrieval_plan_gate.py +76 -0
- package/dist/templates/trellis/scripts/common/retrieval_result_ranking.py +253 -0
- package/dist/templates/trellis/scripts/common/retrieval_tool_classification.py +157 -0
- package/dist/templates/trellis/scripts/common/semantic_plan_gate.py +52 -0
- package/dist/templates/trellis/scripts/common/workflow_phase.py +3 -24
- package/dist/templates/trellis/scripts/rank_retrieval_candidates.py +80 -0
- package/dist/templates/trellis/scripts/route_codebase_retrieval.py +38 -11
- package/dist/templates/trellis/scripts/score_evidence.py +112 -0
- package/dist/templates/trellis/workflow.md +861 -960
- package/dist/types/ai-tools.d.ts +13 -16
- package/dist/types/ai-tools.d.ts.map +1 -1
- package/dist/types/ai-tools.js +5 -238
- package/dist/types/ai-tools.js.map +1 -1
- package/dist/utils/codebase-retrieval-router.d.ts +1 -8
- package/dist/utils/codebase-retrieval-router.d.ts.map +1 -1
- package/dist/utils/codebase-retrieval-router.js +39 -180
- package/dist/utils/codebase-retrieval-router.js.map +1 -1
- package/dist/utils/project-capabilities.d.ts.map +1 -1
- package/dist/utils/project-capabilities.js +10 -24
- package/dist/utils/project-capabilities.js.map +1 -1
- package/dist/utils/retrieval-agent-instructions.d.ts +14 -0
- package/dist/utils/retrieval-agent-instructions.d.ts.map +1 -0
- package/dist/utils/retrieval-agent-instructions.js +221 -0
- package/dist/utils/retrieval-agent-instructions.js.map +1 -0
- package/dist/utils/retrieval-execution-telemetry.d.ts +43 -85
- package/dist/utils/retrieval-execution-telemetry.d.ts.map +1 -1
- package/dist/utils/retrieval-execution-telemetry.js +289 -22
- package/dist/utils/retrieval-execution-telemetry.js.map +1 -1
- package/dist/utils/retrieval-result-ranking.js +1 -1
- package/dist/utils/retrieval-result-ranking.js.map +1 -1
- package/dist/utils/retrieval-tool-classification.d.ts +32 -0
- package/dist/utils/retrieval-tool-classification.d.ts.map +1 -0
- package/dist/utils/retrieval-tool-classification.js +113 -0
- package/dist/utils/retrieval-tool-classification.js.map +1 -0
- package/dist/utils/uninstall-scrubbers.d.ts +0 -36
- package/dist/utils/uninstall-scrubbers.d.ts.map +1 -1
- package/dist/utils/uninstall-scrubbers.js +0 -184
- package/dist/utils/uninstall-scrubbers.js.map +1 -1
- package/package.json +4 -2
- package/dist/commands/mem.d.ts +0 -30
- package/dist/commands/mem.d.ts.map +0 -1
- package/dist/commands/mem.js +0 -424
- package/dist/commands/mem.js.map +0 -1
- package/dist/configurators/antigravity.d.ts +0 -7
- package/dist/configurators/antigravity.d.ts.map +0 -1
- package/dist/configurators/antigravity.js +0 -19
- package/dist/configurators/antigravity.js.map +0 -1
- package/dist/configurators/claude.d.ts +0 -9
- package/dist/configurators/claude.d.ts.map +0 -1
- package/dist/configurators/claude.js +0 -72
- package/dist/configurators/claude.js.map +0 -1
- package/dist/configurators/codebuddy.d.ts +0 -10
- package/dist/configurators/codebuddy.d.ts.map +0 -1
- package/dist/configurators/codebuddy.js +0 -30
- package/dist/configurators/codebuddy.js.map +0 -1
- package/dist/configurators/codex.d.ts +0 -8
- package/dist/configurators/codex.d.ts.map +0 -1
- package/dist/configurators/codex.js +0 -87
- package/dist/configurators/codex.js.map +0 -1
- package/dist/configurators/copilot.d.ts +0 -10
- package/dist/configurators/copilot.d.ts.map +0 -1
- package/dist/configurators/copilot.js +0 -51
- package/dist/configurators/copilot.js.map +0 -1
- package/dist/configurators/droid.d.ts +0 -10
- package/dist/configurators/droid.d.ts.map +0 -1
- package/dist/configurators/droid.js +0 -30
- package/dist/configurators/droid.js.map +0 -1
- package/dist/configurators/gemini.d.ts +0 -16
- package/dist/configurators/gemini.d.ts.map +0 -1
- package/dist/configurators/gemini.js +0 -38
- package/dist/configurators/gemini.js.map +0 -1
- package/dist/configurators/kilo.d.ts +0 -7
- package/dist/configurators/kilo.d.ts.map +0 -1
- package/dist/configurators/kilo.js +0 -19
- package/dist/configurators/kilo.js.map +0 -1
- package/dist/configurators/kiro.d.ts +0 -8
- package/dist/configurators/kiro.d.ts.map +0 -1
- package/dist/configurators/kiro.js +0 -24
- package/dist/configurators/kiro.js.map +0 -1
- package/dist/configurators/opencode.d.ts +0 -14
- package/dist/configurators/opencode.d.ts.map +0 -1
- package/dist/configurators/opencode.js +0 -96
- package/dist/configurators/opencode.js.map +0 -1
- package/dist/configurators/pi.d.ts +0 -3
- package/dist/configurators/pi.d.ts.map +0 -1
- package/dist/configurators/pi.js +0 -45
- package/dist/configurators/pi.js.map +0 -1
- package/dist/configurators/qoder.d.ts +0 -11
- package/dist/configurators/qoder.d.ts.map +0 -1
- package/dist/configurators/qoder.js +0 -31
- package/dist/configurators/qoder.js.map +0 -1
- package/dist/configurators/windsurf.d.ts +0 -7
- package/dist/configurators/windsurf.d.ts.map +0 -1
- package/dist/configurators/windsurf.js +0 -19
- package/dist/configurators/windsurf.js.map +0 -1
- package/dist/templates/claude/agents/trellis-check.md +0 -124
- package/dist/templates/claude/agents/trellis-implement.md +0 -110
- package/dist/templates/claude/agents/trellis-research.md +0 -137
- package/dist/templates/claude/index.d.ts +0 -22
- package/dist/templates/claude/index.d.ts.map +0 -1
- package/dist/templates/claude/index.js +0 -46
- package/dist/templates/claude/index.js.map +0 -1
- package/dist/templates/claude/settings.json +0 -84
- package/dist/templates/codebuddy/agents/trellis-check.md +0 -115
- package/dist/templates/codebuddy/agents/trellis-implement.md +0 -110
- package/dist/templates/codebuddy/agents/trellis-research.md +0 -137
- package/dist/templates/codebuddy/index.d.ts +0 -15
- package/dist/templates/codebuddy/index.d.ts.map +0 -1
- package/dist/templates/codebuddy/index.js +0 -15
- package/dist/templates/codebuddy/index.js.map +0 -1
- package/dist/templates/codebuddy/settings.json +0 -70
- package/dist/templates/codex/agents/trellis-check.toml +0 -67
- package/dist/templates/codex/agents/trellis-implement.toml +0 -40
- package/dist/templates/codex/agents/trellis-research.toml +0 -73
- package/dist/templates/codex/config.toml +0 -28
- package/dist/templates/codex/hooks/session-start.py +0 -575
- package/dist/templates/codex/hooks.json +0 -15
- package/dist/templates/codex/index.d.ts +0 -39
- package/dist/templates/codex/index.d.ts.map +0 -1
- package/dist/templates/codex/index.js +0 -85
- package/dist/templates/codex/index.js.map +0 -1
- package/dist/templates/codex/skills/before-dev/SKILL.md +0 -40
- package/dist/templates/codex/skills/brainstorm/SKILL.md +0 -112
- package/dist/templates/codex/skills/break-loop/SKILL.md +0 -130
- package/dist/templates/codex/skills/check/SKILL.md +0 -98
- package/dist/templates/codex/skills/check-cross-layer/SKILL.md +0 -158
- package/dist/templates/codex/skills/create-command/SKILL.md +0 -101
- package/dist/templates/codex/skills/finish-work/SKILL.md +0 -90
- package/dist/templates/codex/skills/improve-ut/SKILL.md +0 -69
- package/dist/templates/codex/skills/integrate-skill/SKILL.md +0 -221
- package/dist/templates/codex/skills/onboard/SKILL.md +0 -363
- package/dist/templates/codex/skills/record-session/SKILL.md +0 -67
- package/dist/templates/codex/skills/start/SKILL.md +0 -66
- package/dist/templates/codex/skills/update-spec/SKILL.md +0 -335
- package/dist/templates/copilot/hooks/session-start.py +0 -557
- package/dist/templates/copilot/hooks.json +0 -19
- package/dist/templates/copilot/index.d.ts +0 -23
- package/dist/templates/copilot/index.d.ts.map +0 -1
- package/dist/templates/copilot/index.js +0 -54
- package/dist/templates/copilot/index.js.map +0 -1
- package/dist/templates/copilot/prompts/before-dev.prompt.md +0 -39
- package/dist/templates/copilot/prompts/brainstorm.prompt.md +0 -111
- package/dist/templates/copilot/prompts/break-loop.prompt.md +0 -129
- package/dist/templates/copilot/prompts/check-cross-layer.prompt.md +0 -157
- package/dist/templates/copilot/prompts/check.prompt.md +0 -97
- package/dist/templates/copilot/prompts/create-command.prompt.md +0 -116
- package/dist/templates/copilot/prompts/finish-work.prompt.md +0 -99
- package/dist/templates/copilot/prompts/integrate-skill.prompt.md +0 -223
- package/dist/templates/copilot/prompts/onboard.prompt.md +0 -362
- package/dist/templates/copilot/prompts/parallel.prompt.md +0 -204
- package/dist/templates/copilot/prompts/record-session.prompt.md +0 -66
- package/dist/templates/copilot/prompts/start.prompt.md +0 -63
- package/dist/templates/copilot/prompts/update-spec.prompt.md +0 -358
- package/dist/templates/droid/droids/trellis-check.md +0 -107
- package/dist/templates/droid/droids/trellis-implement.md +0 -102
- package/dist/templates/droid/droids/trellis-research.md +0 -137
- package/dist/templates/droid/index.d.ts +0 -15
- package/dist/templates/droid/index.d.ts.map +0 -1
- package/dist/templates/droid/index.js +0 -15
- package/dist/templates/droid/index.js.map +0 -1
- package/dist/templates/droid/settings.json +0 -70
- package/dist/templates/gemini/agents/trellis-check.md +0 -107
- package/dist/templates/gemini/agents/trellis-implement.md +0 -102
- package/dist/templates/gemini/agents/trellis-research.md +0 -136
- package/dist/templates/gemini/index.d.ts +0 -13
- package/dist/templates/gemini/index.d.ts.map +0 -1
- package/dist/templates/gemini/index.js +0 -13
- package/dist/templates/gemini/index.js.map +0 -1
- package/dist/templates/gemini/settings.json +0 -28
- package/dist/templates/kiro/agents/trellis-check.json +0 -26
- package/dist/templates/kiro/agents/trellis-implement.json +0 -26
- package/dist/templates/kiro/agents/trellis-research.json +0 -30
- package/dist/templates/kiro/index.d.ts +0 -18
- package/dist/templates/kiro/index.d.ts.map +0 -1
- package/dist/templates/kiro/index.js +0 -18
- package/dist/templates/kiro/index.js.map +0 -1
- package/dist/templates/opencode/agents/trellis-check.md +0 -122
- package/dist/templates/opencode/agents/trellis-implement.md +0 -118
- package/dist/templates/opencode/agents/trellis-research.md +0 -145
- package/dist/templates/opencode/lib/session-utils.js +0 -667
- package/dist/templates/opencode/lib/trellis-context.js +0 -336
- package/dist/templates/opencode/package.json +0 -5
- package/dist/templates/opencode/plugins/inject-subagent-context.js +0 -495
- package/dist/templates/opencode/plugins/inject-workflow-state.js +0 -159
- package/dist/templates/opencode/plugins/session-start.js +0 -101
- package/dist/templates/pi/agents/trellis-check.md +0 -37
- package/dist/templates/pi/agents/trellis-implement.md +0 -42
- package/dist/templates/pi/agents/trellis-research.md +0 -25
- package/dist/templates/pi/extensions/trellis/index.ts.txt +0 -1600
- package/dist/templates/pi/index.d.ts +0 -5
- package/dist/templates/pi/index.d.ts.map +0 -1
- package/dist/templates/pi/index.js +0 -12
- package/dist/templates/pi/index.js.map +0 -1
- package/dist/templates/pi/settings.json +0 -12
- package/dist/templates/qoder/agents/trellis-check.md +0 -108
- package/dist/templates/qoder/agents/trellis-implement.md +0 -103
- package/dist/templates/qoder/agents/trellis-research.md +0 -137
- package/dist/templates/qoder/index.d.ts +0 -15
- package/dist/templates/qoder/index.d.ts.map +0 -1
- package/dist/templates/qoder/index.js +0 -15
- package/dist/templates/qoder/index.js.map +0 -1
- package/dist/templates/qoder/settings.json +0 -47
package/README.md
CHANGED
|
@@ -1,9 +1,128 @@
|
|
|
1
1
|
# cursor-trellis
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
English | [简体中文](README.zh-CN.md)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
- **CLI:** `trellis` / `tl` (binaries unchanged; only the npm package name changed from `@blxzer/trellis`)
|
|
7
|
-
- **Docs:** see [packages/cli/README.md](./packages/cli/README.md) and [packages/cli/CHANGELOG.md](./packages/cli/CHANGELOG.md)
|
|
5
|
+
**Trellis** is a team harness for AI coding agents: it replaces one giant `AGENTS.md` / `.cursorrules` with a progressive `.trellis/` wiki—workflow, specs, tasks, and journals—plus generated **Cursor** integration (rules, commands, agents, hooks).
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
This repository is a **public fork** focused on **Cursor-first** workflow. Upstream inspiration: [mindfold-ai/Trellis](https://github.com/mindfold-ai/Trellis).
|
|
8
|
+
|
|
9
|
+
| | |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| **npm CLI** | `@blxzer/cursor-trellis` (`trellis`, `tl`, `smart-search`) |
|
|
12
|
+
| **Core SDK** | `@blxzer/cursor-trellis-core` |
|
|
13
|
+
| **This repo** | https://github.com/blxzer77/cursor-trellis |
|
|
14
|
+
|
|
15
|
+
## What problem it solves
|
|
16
|
+
|
|
17
|
+
- **Context rot**: agents miss rules buried in a single markdown file.
|
|
18
|
+
- **No task continuity**: PRDs, design, and verification scatter across chats.
|
|
19
|
+
- **Platform drift**: Cursor rules, commands, hooks, and agents each need the right shape.
|
|
20
|
+
|
|
21
|
+
Trellis generates the **Cursor adapter** (`.cursor/`) for your stack. This fork is **Cursor-only** for init and public docs (see [docs/cursor.md](docs/cursor.md)).
|
|
22
|
+
|
|
23
|
+
## Quick start (Cursor)
|
|
24
|
+
|
|
25
|
+
**1. Install the CLI** (global or project-local):
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g @blxzer/cursor-trellis
|
|
29
|
+
trellis --version
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**2. Initialize your application repo** (not the Trellis source tree):
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
cd /path/to/your-app
|
|
36
|
+
trellis init --cursor
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**3. Open the project in Cursor** and use Agent mode. User-facing slash commands include `/trellis-continue` and `/trellis-finish-work`. Request Triage is enforced via `.cursor/rules/trellis-triage.mdc`.
|
|
40
|
+
|
|
41
|
+
Optional: `trellis init --cursor --cursor2plus` for Cursor++ BYOK local bundle; see [docs/cursor.md](docs/cursor.md#cursor-optional-appendix).
|
|
42
|
+
|
|
43
|
+
## After init: what appears
|
|
44
|
+
|
|
45
|
+
```text
|
|
46
|
+
your-app/
|
|
47
|
+
.trellis/ workflow, spec, tasks, workspace, scripts
|
|
48
|
+
AGENTS.md Trellis-managed agent entry
|
|
49
|
+
.cursor/ commands, rules, agents, hooks (Cursor)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Details: [Cursor integration](docs/cursor.md).
|
|
53
|
+
|
|
54
|
+
## Core concepts
|
|
55
|
+
|
|
56
|
+
| Path | Role |
|
|
57
|
+
| --- | --- |
|
|
58
|
+
| `.trellis/workflow.md` | Lifecycle: triage, plan, execute, finish, learning |
|
|
59
|
+
| `.trellis/spec/` | Layer/package coding guidelines |
|
|
60
|
+
| `.trellis/tasks/` | PRD, design, implement, verify artifacts |
|
|
61
|
+
| `.trellis/workspace/` | Developer journals and session traces |
|
|
62
|
+
|
|
63
|
+
## Workflow (summary)
|
|
64
|
+
|
|
65
|
+
1. **Triage** every request (`No Task` → `Parent Task`).
|
|
66
|
+
2. **Plan** with task artifacts for durable work (especially Full Tasks).
|
|
67
|
+
3. **Gate**: `task.py validate` + `start-execution --check`.
|
|
68
|
+
4. **Approve** execution explicitly, then `start-execution --approved`.
|
|
69
|
+
5. **Verify** and finish (`/trellis-finish-work`).
|
|
70
|
+
|
|
71
|
+
Walkthrough: [docs/workflow.md](docs/workflow.md).
|
|
72
|
+
|
|
73
|
+
## Cursor support
|
|
74
|
+
|
|
75
|
+
- **Rules** — reliable always-on policy (including Triage).
|
|
76
|
+
- **Commands** — small `/` palette (`commands-only` policy; skills not copied to `.cursor/skills/` by default).
|
|
77
|
+
- **Agents** — `trellis-research`, `trellis-implement`, `trellis-check`.
|
|
78
|
+
- **Hooks** — Python scripts for session, shell, and subagent context.
|
|
79
|
+
|
|
80
|
+
Deep dive: [docs/cursor.md](docs/cursor.md).
|
|
81
|
+
|
|
82
|
+
## Common commands
|
|
83
|
+
|
|
84
|
+
| Command | Purpose |
|
|
85
|
+
| --- | --- |
|
|
86
|
+
| `trellis init --cursor` | Create `.trellis/` + `.cursor/` in the current project |
|
|
87
|
+
| `trellis update` | Refresh templates from the installed CLI version |
|
|
88
|
+
| `trellis uninstall` | Remove Trellis-managed files from the project |
|
|
89
|
+
|
|
90
|
+
Flags and behavior: [packages/cli/README.md](packages/cli/README.md).
|
|
91
|
+
|
|
92
|
+
Other CLI commands (`rollout`, `upgrade`, …) are listed briefly in the CLI README only.
|
|
93
|
+
|
|
94
|
+
## Architecture (summary)
|
|
95
|
+
|
|
96
|
+
Monorepo: `packages/core` (SDK) + `packages/cli` (templates, configurators, bins). Init flows through `configureCursor()` into your `.cursor/` tree. **smart-search** ships as a vendored CLI for web research.
|
|
97
|
+
|
|
98
|
+
Diagram and data flow: [docs/architecture.md](docs/architecture.md).
|
|
99
|
+
|
|
100
|
+
## Development and verification
|
|
101
|
+
|
|
102
|
+
Contributors working on **this** repository:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
pnpm install
|
|
106
|
+
pnpm build
|
|
107
|
+
pnpm test
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Package-level detail: [packages/cli/README.md](packages/cli/README.md). Agent-oriented codebase guide: [AGENTS.md](AGENTS.md).
|
|
111
|
+
|
|
112
|
+
## Maintainer note
|
|
113
|
+
|
|
114
|
+
Local harness layout (`D:\MyHarness`), Git remote policy, release/publish, and deep implementation notes are **internal**—see [docs/maintainers.md](docs/maintainers.md). Public docs intentionally omit npm publish and private remote procedures.
|
|
115
|
+
|
|
116
|
+
## Read more
|
|
117
|
+
|
|
118
|
+
| Doc | Topic |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| [docs/workflow.md](docs/workflow.md) | Task lifecycle in Cursor |
|
|
121
|
+
| [docs/cursor.md](docs/cursor.md) | Generated Cursor files |
|
|
122
|
+
| [docs/architecture.md](docs/architecture.md) | High-level structure + smart-search |
|
|
123
|
+
| [packages/cli/README.md](packages/cli/README.md) | CLI / npm reference |
|
|
124
|
+
| [CHANGELOG](packages/cli/CHANGELOG.md) | Package history |
|
|
125
|
+
|
|
126
|
+
## License
|
|
127
|
+
|
|
128
|
+
AGPL-3.0-only — see package metadata in `packages/cli/package.json`.
|
package/README.zh-CN.md
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# @blxzer/cursor-trellis
|
|
2
|
+
|
|
3
|
+
[English](README.md) | 简体中文
|
|
4
|
+
|
|
5
|
+
Trellis CLI 的 npm 包。项目总览:[../../README.zh-CN.md](../../README.zh-CN.md)。Cursor 工作流:[../../docs/workflow.zh-CN.md](../../docs/workflow.zh-CN.md)。
|
|
6
|
+
|
|
7
|
+
## 安装
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @blxzer/cursor-trellis
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
需要 **Node.js ≥ 18.17**。生成项目的钩子在运行 Cursor 的机器上需要 **Python ≥ 3.9**。
|
|
14
|
+
|
|
15
|
+
## 可执行文件
|
|
16
|
+
|
|
17
|
+
| Bin | 别名 | 作用 |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| `trellis` | `tl` | 在项目中初始化、更新、管理 Trellis |
|
|
20
|
+
| `smart-search` | — | 随包分发的网页检索 CLI(见 [smart-search](#smart-search)) |
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
trellis --version
|
|
24
|
+
smart-search --version
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 命令一览(摘要)
|
|
28
|
+
|
|
29
|
+
| 命令 | 用途 |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| `init` | 创建 `.trellis/` 与所选平台目录 |
|
|
32
|
+
| `update` | 将模板同步到当前安装的 CLI 版本 |
|
|
33
|
+
| `uninstall` | 从项目中移除 Trellis 管理文件 |
|
|
34
|
+
| `upgrade` | 升级全局 CLI npm 包 |
|
|
35
|
+
| `rollout` | 对多个项目路径批量 `update` |
|
|
36
|
+
| `workflow` | 工作流模板工具(进阶) |
|
|
37
|
+
|
|
38
|
+
与 **channel** 相关的命令服务于进阶多 Agent 工作流,不属于 Cursor-first 公开文档范围。完整列表:`trellis --help`。
|
|
39
|
+
|
|
40
|
+
下文详述 **`init`**、**`update`**、**`uninstall`**。
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## `trellis init`
|
|
45
|
+
|
|
46
|
+
在**目标项目根目录**执行:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
trellis init --cursor
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 平台标志
|
|
53
|
+
|
|
54
|
+
| 标志 | 平台 |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| `--cursor` | Cursor(`.cursor/`)— 默认文档路径 |
|
|
57
|
+
| `--cursor2plus` | Cursor++ BYOK 本地包(须同时 `--cursor`) |
|
|
58
|
+
|
|
59
|
+
本 fork 的 init 与公开文档为 **Cursor-only**:[../../docs/cursor.zh-CN.md](../../docs/cursor.zh-CN.md)。
|
|
60
|
+
|
|
61
|
+
### 常用标志
|
|
62
|
+
|
|
63
|
+
| 标志 | 说明 |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| `-y, --yes` | 非交互默认项 |
|
|
66
|
+
| `-f, --force` | 覆盖已有受管文件 |
|
|
67
|
+
| `-s, --skip-existing` | 跳过已存在文件 |
|
|
68
|
+
| `--cursor2plus` | 物化 Cursor++ BYOK 包(须同时 `--cursor`) |
|
|
69
|
+
| `-u, --user <name>` | 开发者身份 |
|
|
70
|
+
| `--skip-readiness` | 跳过 smart-search / 能力项 readiness |
|
|
71
|
+
| `--capability <id>` | 启用可选能力(可重复;`all` 表示全部可选) |
|
|
72
|
+
| `--workflow <id>` | `.trellis/workflow.md` 工作流模板 |
|
|
73
|
+
| `-t, --template <name>` | 远程 spec 模板 |
|
|
74
|
+
| `-r, --registry <source>` | 自定义模板 registry |
|
|
75
|
+
| `--monorepo` / `--no-monorepo` | monorepo 检测覆盖 |
|
|
76
|
+
|
|
77
|
+
### 生成内容
|
|
78
|
+
|
|
79
|
+
- `.trellis/` — workflow、spec、tasks、workspace、scripts、模板哈希
|
|
80
|
+
- `AGENTS.md` — 受管说明块
|
|
81
|
+
- 平台目录 — Cursor 下为 `.cursor/commands`、`rules`、`agents`、`hooks`、`hooks.json`、`worktrees.json`
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## `trellis update`
|
|
86
|
+
|
|
87
|
+
在已有 `.trellis/` 的项目根目录:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
trellis update
|
|
91
|
+
trellis update --dry-run
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 标志
|
|
95
|
+
|
|
96
|
+
| 标志 | 说明 |
|
|
97
|
+
| --- | --- |
|
|
98
|
+
| `--dry-run` | 仅预览不写盘 |
|
|
99
|
+
| `-f, --force` | 覆盖所有有变更的受管文件 |
|
|
100
|
+
| `-s, --skip-all` | 跳过所有有变更文件 |
|
|
101
|
+
| `-n, --create-new` | 对有变更文件写 `.new` 副本 |
|
|
102
|
+
| `--migrate` | 执行待处理路径迁移(重命名/删除) |
|
|
103
|
+
| `--allow-downgrade` | 允许模板版本低于记录版本 |
|
|
104
|
+
| `--skip-readiness` | 跳过 readiness 复检 |
|
|
105
|
+
| `--json` | 单行 JSON rollout 证据 |
|
|
106
|
+
| `--skip-post-update-smoke` | 跳过应用后 Python 冒烟脚本 |
|
|
107
|
+
|
|
108
|
+
常见流程:升级全局 CLI → 进入项目 → `trellis update` → 若自定义过 workflow/rules 请审阅 diff。
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## `trellis uninstall`
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
trellis uninstall
|
|
116
|
+
trellis uninstall --dry-run
|
|
117
|
+
trellis uninstall -y
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### 标志
|
|
121
|
+
|
|
122
|
+
| 标志 | 说明 |
|
|
123
|
+
| --- | --- |
|
|
124
|
+
| `-y, --yes` | 跳过确认 |
|
|
125
|
+
| `--dry-run` | 仅列出将删除/_scrub_ 的内容 |
|
|
126
|
+
|
|
127
|
+
按哈希清单与结构化 scrubber 移除受管平台文件及 `.trellis/`。卸载前请**备份**自定义 workflow 或 rules。
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## smart-search
|
|
132
|
+
|
|
133
|
+
内置于本包(`vendor/smart-search/`,bin 名 `smart-search`)。
|
|
134
|
+
|
|
135
|
+
| 主题 | 说明 |
|
|
136
|
+
| --- | --- |
|
|
137
|
+
| 是什么 | 用于 search、fetch、doctor、research 的 CLI,**不是** MCP 服务 |
|
|
138
|
+
| Agent 何时用 | 项目 `.trellis/workflow.md` 约定外部事实在健康时**优先**走 smart-search |
|
|
139
|
+
| 配置 | `smart-search setup`、`smart-search doctor`(见 [vendor README](vendor/smart-search/README.zh-CN.md)) |
|
|
140
|
+
| Readiness | `init`/`update` 默认检查,可用 `--skip-readiness` 跳过 |
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
smart-search search "查询" --format json
|
|
144
|
+
smart-search doctor --format markdown
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
更新 vendor 快照为维护者操作(本包内 `pnpm run sync:smart-search`)。见 [../../docs/maintainers.md](../../docs/maintainers.md)。
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## 维护者脚本(本包)
|
|
152
|
+
|
|
153
|
+
面向**编辑本仓库**的贡献者,终端用户不必运行:
|
|
154
|
+
|
|
155
|
+
| 脚本 | 用途 |
|
|
156
|
+
| --- | --- |
|
|
157
|
+
| `pnpm build` | `tsc` + 拷贝模板 |
|
|
158
|
+
| `pnpm test` | Vitest |
|
|
159
|
+
| `pnpm run sync:smart-search` | 刷新 vendor |
|
|
160
|
+
|
|
161
|
+
Release 与 npm 发布流程**不在**公开 README 中;见内部维护文档。
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 延伸阅读
|
|
166
|
+
|
|
167
|
+
- [项目 README](../../README.zh-CN.md)
|
|
168
|
+
- [Cursor 集成](../../docs/cursor.zh-CN.md)
|
|
169
|
+
- [架构概览](../../docs/architecture.zh-CN.md)
|
|
170
|
+
- [CHANGELOG](./CHANGELOG.md)
|
package/dist/cli/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAIhE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC"}
|
package/dist/cli/index.js
CHANGED
|
@@ -7,7 +7,6 @@ import { update } from "../commands/update.js";
|
|
|
7
7
|
import { rollout } from "../commands/rollout.js";
|
|
8
8
|
import { upgrade } from "../commands/upgrade.js";
|
|
9
9
|
import { uninstall } from "../commands/uninstall.js";
|
|
10
|
-
import { runMem } from "../commands/mem.js";
|
|
11
10
|
import { runWorkflowCommand, WorkflowCommandError, } from "../commands/workflow.js";
|
|
12
11
|
import { registerChannelCommand } from "../commands/channel/index.js";
|
|
13
12
|
import { DIR_NAMES } from "../constants/paths.js";
|
|
@@ -47,25 +46,12 @@ function collectOption(value, previous) {
|
|
|
47
46
|
}
|
|
48
47
|
program
|
|
49
48
|
.name("trellis")
|
|
50
|
-
.description("AI-assisted development workflow framework for
|
|
49
|
+
.description("AI-assisted development workflow framework for Cursor")
|
|
51
50
|
.version(VERSION, "-v, --version", "output the version number");
|
|
52
51
|
program
|
|
53
52
|
.command("init")
|
|
54
53
|
.description("Initialize trellis in the current project")
|
|
55
54
|
.option("--cursor", "Include Cursor commands")
|
|
56
|
-
.option("--claude", "Include Claude Code commands")
|
|
57
|
-
.option("--opencode", "Include OpenCode commands")
|
|
58
|
-
.option("--codex", "Include Codex skills")
|
|
59
|
-
.option("--kilo", "Include Kilo CLI commands")
|
|
60
|
-
.option("--kiro", "Include Kiro Code skills")
|
|
61
|
-
.option("--gemini", "Include Gemini CLI commands")
|
|
62
|
-
.option("--antigravity", "Include Antigravity workflows")
|
|
63
|
-
.option("--windsurf", "Include Windsurf workflows")
|
|
64
|
-
.option("--qoder", "Include Qoder commands")
|
|
65
|
-
.option("--codebuddy", "Include CodeBuddy commands")
|
|
66
|
-
.option("--copilot", "Include GitHub Copilot hooks")
|
|
67
|
-
.option("--droid", "Include Factory Droid commands")
|
|
68
|
-
.option("--pi", "Include Pi Agent extension assets")
|
|
69
55
|
.option("-y, --yes", "Skip prompts and use defaults")
|
|
70
56
|
.option("--cursor2plus", "Materialize Cursor++ BYOK local bundle (.trellis/local/cursor2plus/); ignored unless --cursor is also selected")
|
|
71
57
|
.option("-u, --user <name>", "Initialize developer identity with specified name")
|
|
@@ -205,24 +191,6 @@ program
|
|
|
205
191
|
process.exit(1);
|
|
206
192
|
}
|
|
207
193
|
});
|
|
208
|
-
program
|
|
209
|
-
.command("mem")
|
|
210
|
-
.description("Search/recall AI conversation history across Claude Code, Codex, OpenCode (run 'trellis mem help' for subcommands and flags)")
|
|
211
|
-
.allowUnknownOption(true)
|
|
212
|
-
.helpOption(false)
|
|
213
|
-
.argument("[args...]", "subcommand and arguments (list|search|context|extract|projects|help)")
|
|
214
|
-
.action((args = []) => {
|
|
215
|
-
try {
|
|
216
|
-
runMem(args);
|
|
217
|
-
}
|
|
218
|
-
catch (error) {
|
|
219
|
-
console.error(chalk.red("Error:"), error instanceof Error ? error.message : error);
|
|
220
|
-
if (process.env.DEBUG || process.env.TRELLIS_DEBUG) {
|
|
221
|
-
console.error(error instanceof Error ? error.stack : error);
|
|
222
|
-
}
|
|
223
|
-
process.exit(1);
|
|
224
|
-
}
|
|
225
|
-
});
|
|
226
194
|
program
|
|
227
195
|
.command("workflow")
|
|
228
196
|
.description("List or switch the project's .trellis/workflow.md template (native, tdd, channel-driven-subagent-dispatch, or marketplace)")
|
package/dist/cli/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EACL,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,uFAAuF;AACvF,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;AAEjC;;GAEG;AACH,SAAS,eAAe,CAAC,GAAW;IAClC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAEnE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO;IAExC,MAAM,cAAc,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IACpE,MAAM,UAAU,GAAG,OAAO,CAAC;IAC3B,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAE/D,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,+CAA+C;QAC/C,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,MAAM,CACV,mCAAmC,cAAc,MAAM,UAAU,EAAE,CACpE,CACF,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QAC1B,iDAAiD;QACjD,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,MAAM,CACV,mBAAmB,UAAU,4BAA4B,cAAc,GAAG,CAC3E,CACF,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAC1B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;IACtD,eAAe,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,SAAS,aAAa,CAAC,KAAa,EAAE,QAAkB;IACtD,OAAO,CAAC,GAAG,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,SAAS,CAAC;KACf,WAAW,CAAC,uDAAuD,CAAC;KACpE,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;AAElE,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,2CAA2C,CAAC;KACxD,MAAM,CAAC,UAAU,EAAE,yBAAyB,CAAC;KAC7C,MAAM,CAAC,WAAW,EAAE,+BAA+B,CAAC;KACpD,MAAM,CACL,eAAe,EACf,gHAAgH,CACjH;KACA,MAAM,CACL,mBAAmB,EACnB,mDAAmD,CACpD;KACA,MAAM,CAAC,aAAa,EAAE,yCAAyC,CAAC;KAChE,MAAM,CAAC,qBAAqB,EAAE,oCAAoC,CAAC;KACnE,MAAM,CACL,kBAAkB,EAClB,yGAAyG,CAC1G;KACA,MAAM,CACL,mBAAmB,EACnB,+FAA+F,EAC/F,aAAa,EACb,EAAE,CACH;KACA,MAAM,CAAC,YAAY,EAAE,qBAAqB,CAAC;KAC3C,MAAM,CAAC,eAAe,EAAE,yBAAyB,CAAC;KAClD,MAAM,CACL,uBAAuB,EACvB,uDAAuD,CACxD;KACA,MAAM,CACL,aAAa,EACb,uDAAuD,CACxD;KACA,MAAM,CAAC,UAAU,EAAE,4CAA4C,CAAC;KAChE,MAAM,CACL,yBAAyB,EACzB,8DAA8D,CAC/D;KACA,MAAM,CACL,iBAAiB,EACjB,8GAA8G,CAC/G;KACA,MAAM,CACL,4BAA4B,EAC5B,yFAAyF,CAC1F;KACA,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,QAAQ,CAAC;KACjB,WAAW,CAAC,6DAA6D,CAAC;KAC1E,MAAM,CAAC,WAAW,EAAE,uCAAuC,CAAC;KAC5D,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC;KACnE,MAAM,CAAC,gBAAgB,EAAE,uCAAuC,CAAC;KACjE,MAAM,CAAC,kBAAkB,EAAE,0CAA0C,CAAC;KACtE,MAAM,CAAC,mBAAmB,EAAE,uCAAuC,CAAC;KACpE,MAAM,CAAC,WAAW,EAAE,mDAAmD,CAAC;KACxE,MAAM,CACL,kBAAkB,EAClB,yGAAyG,CAC1G;KACA,MAAM,CACL,QAAQ,EACR,wDAAwD,CACzD;KACA,MAAM,CACL,0BAA0B,EAC1B,4CAA4C,CAC7C;KACA,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC;YACX,MAAM,EAAE,OAAO,CAAC,MAAiB;YACjC,KAAK,EAAE,OAAO,CAAC,KAAgB;YAC/B,OAAO,EAAE,OAAO,CAAC,OAAkB;YACnC,SAAS,EAAE,OAAO,CAAC,SAAoB;YACvC,cAAc,EAAE,OAAO,CAAC,cAAyB;YACjD,OAAO,EAAE,OAAO,CAAC,OAAkB;YACnC,aAAa,EAAE,OAAO,CAAC,aAAwB;YAC/C,IAAI,EAAE,OAAO,CAAC,IAAe;YAC7B,mBAAmB,EAAE,OAAO,CAAC,mBAA8B;SAC5D,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CACV,iFAAiF,CAClF;KACA,cAAc,CACb,sBAAsB,EACtB,0CAA0C,EAC1C,CAAC,GAAW,EAAE,IAA0B,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EACnE,EAAc,CACf;KACA,MAAM,CAAC,WAAW,EAAE,kCAAkC,CAAC;KACvD,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC;KACnE,MAAM,CAAC,gBAAgB,EAAE,uCAAuC,CAAC;KACjE,MAAM,CAAC,kBAAkB,EAAE,0CAA0C,CAAC;KACtE,MAAM,CAAC,WAAW,EAAE,+BAA+B,CAAC;KACpD,MAAM,CAAC,mBAAmB,EAAE,mCAAmC,CAAC;KAChE,MAAM,CAAC,kBAAkB,EAAE,uBAAuB,CAAC;KACnD,MAAM,CAAC,0BAA0B,EAAE,8BAA8B,CAAC;KAClE,MAAM,CAAC,QAAQ,EAAE,uCAAuC,CAAC;KACzD,MAAM,CAAC,qBAAqB,EAAE,6BAA6B,CAAC;KAC5D,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,OAAO,CAAC;YACZ,QAAQ,EAAE,OAAO,CAAC,OAAmB;YACrC,MAAM,EAAE,OAAO,CAAC,MAAiB;YACjC,KAAK,EAAE,OAAO,CAAC,KAAgB;YAC/B,OAAO,EAAE,OAAO,CAAC,OAAkB;YACnC,SAAS,EAAE,OAAO,CAAC,SAAoB;YACvC,OAAO,EAAE,OAAO,CAAC,OAAkB;YACnC,cAAc,EAAE,OAAO,CAAC,cAAyB;YACjD,aAAa,EAAE,OAAO,CAAC,aAAwB;YAC/C,mBAAmB,EAAE,OAAO,CAAC,mBAA8B;YAC3D,IAAI,EAAE,OAAO,CAAC,IAAe;YAC7B,MAAM,EAAE,OAAO,CAAC,MAA4B;SAC7C,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,wCAAwC,CAAC;KACrD,MAAM,CACL,aAAa,EACb,2FAA2F,CAC5F;KACA,MAAM,CAAC,WAAW,EAAE,8CAA8C,CAAC;KACnE,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,OAAO,CAAC;YACZ,GAAG,EAAE,OAAO,CAAC,GAAyB;YACtC,MAAM,EAAE,OAAO,CAAC,MAAiB;SAClC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,WAAW,CAAC;KACpB,WAAW,CACV,iFAAiF,CAClF;KACA,MAAM,CAAC,WAAW,EAAE,0BAA0B,CAAC;KAC/C,MAAM,CAAC,WAAW,EAAE,sDAAsD,CAAC;KAC3E,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,SAAS,CAAC;YACd,GAAG,EAAE,OAAO,CAAC,GAAc;YAC3B,MAAM,EAAE,OAAO,CAAC,MAAiB;SAClC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CACV,4HAA4H,CAC7H;KACA,MAAM,CACL,qBAAqB,EACrB,4EAA4E,CAC7E;KACA,MAAM,CACL,4BAA4B,EAC5B,+DAA+D,CAChE;KACA,MAAM,CAAC,QAAQ,EAAE,4CAA4C,CAAC;KAC9D,MAAM,CAAC,aAAa,EAAE,iDAAiD,CAAC;KACxE,MAAM,CACL,kBAAkB,EAClB,yEAAyE,CAC1E;KACA,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;IACjD,IAAI,CAAC;QACH,MAAM,kBAAkB,CAAC;YACvB,QAAQ,EAAE,OAAO,CAAC,QAA8B;YAChD,WAAW,EAAE,OAAO,CAAC,WAAiC;YACtD,IAAI,EAAE,OAAO,CAAC,IAA2B;YACzC,KAAK,EAAE,OAAO,CAAC,KAA4B;YAC3C,SAAS,EAAE,OAAO,CAAC,SAAgC;SACpD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EACnB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAEhC,OAAO,CAAC,KAAK,EAAE,CAAC"}
|
package/dist/commands/init.d.ts
CHANGED
|
@@ -29,19 +29,6 @@ export declare function resolveSupportedPython(): {
|
|
|
29
29
|
export declare function slugifyDeveloperName(name: string): string;
|
|
30
30
|
interface InitOptions {
|
|
31
31
|
cursor?: boolean;
|
|
32
|
-
claude?: boolean;
|
|
33
|
-
opencode?: boolean;
|
|
34
|
-
codex?: boolean;
|
|
35
|
-
kilo?: boolean;
|
|
36
|
-
kiro?: boolean;
|
|
37
|
-
gemini?: boolean;
|
|
38
|
-
antigravity?: boolean;
|
|
39
|
-
windsurf?: boolean;
|
|
40
|
-
qoder?: boolean;
|
|
41
|
-
codebuddy?: boolean;
|
|
42
|
-
copilot?: boolean;
|
|
43
|
-
droid?: boolean;
|
|
44
|
-
pi?: boolean;
|
|
45
32
|
yes?: boolean;
|
|
46
33
|
user?: string;
|
|
47
34
|
force?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AA6EA,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAUvE;AAuBD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAkC9D;AAmBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,IAAI;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAoEA;AAuDD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOzD;
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AA6EA,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAUvE;AAuBD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAkC9D;AAmBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,IAAI;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAoEA;AAuDD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOzD;AAqoBD,UAAU,WAAW;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AA6LD,wBAAsB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAk7B9D"}
|
package/dist/commands/init.js
CHANGED
|
@@ -280,7 +280,7 @@ listed in per-task jsonl manifests. Empty spec = sub-agents write generic
|
|
|
280
280
|
code. Real spec = sub-agents match the team's actual patterns.
|
|
281
281
|
|
|
282
282
|
Don't dump instructions. Open with a short greeting, figure out if the repo
|
|
283
|
-
has any existing convention docs (
|
|
283
|
+
has any existing convention docs (AGENTS.md, .cursorrules, CONTRIBUTING.md, etc.), and drive
|
|
284
284
|
the rest conversationally.
|
|
285
285
|
|
|
286
286
|
---
|
|
@@ -335,18 +335,11 @@ Search the repo for existing convention docs. If any exist, read them and
|
|
|
335
335
|
extract the relevant rules into the matching \`.trellis/spec/\` files —
|
|
336
336
|
usually much faster than documenting from scratch.
|
|
337
337
|
|
|
338
|
-
| File / Directory |
|
|
338
|
+
| File / Directory | Notes |
|
|
339
339
|
|------|------|
|
|
340
|
-
| \`
|
|
341
|
-
| \`
|
|
342
|
-
| \`.
|
|
343
|
-
| \`.cursor/rules/*.mdc\` | Cursor (rules directory) |
|
|
344
|
-
| \`.windsurfrules\` | Windsurf |
|
|
345
|
-
| \`.clinerules\` | Cline |
|
|
346
|
-
| \`.roomodes\` | Roo Code |
|
|
347
|
-
| \`.github/copilot-instructions.md\` | GitHub Copilot |
|
|
348
|
-
| \`.vscode/settings.json\` → \`github.copilot.chat.codeGeneration.instructions\` | VS Code Copilot |
|
|
349
|
-
| \`CONVENTIONS.md\` / \`.aider.conf.yml\` | aider |
|
|
340
|
+
| \`AGENTS.md\` | Agent entry / managed instructions |
|
|
341
|
+
| \`.cursorrules\` | Legacy Cursor rules file |
|
|
342
|
+
| \`.cursor/rules/*.mdc\` | Cursor rules directory |
|
|
350
343
|
| \`CONTRIBUTING.md\` | General project conventions |
|
|
351
344
|
| \`.editorconfig\` | Editor formatting rules |
|
|
352
345
|
|
|
@@ -401,7 +394,7 @@ After archive, every new developer who joins this project will get a
|
|
|
401
394
|
"Welcome to Trellis! Your init just set me up to help you fill the project
|
|
402
395
|
spec — a one-time setup so every future AI session follows the team's
|
|
403
396
|
conventions instead of writing generic code. Before we start, do you have
|
|
404
|
-
any existing convention docs (
|
|
397
|
+
any existing convention docs (AGENTS.md, .cursorrules, CONTRIBUTING.md,
|
|
405
398
|
etc.) I can pull from, or should I scan the codebase from scratch?"
|
|
406
399
|
`;
|
|
407
400
|
let content = header;
|
|
@@ -629,7 +622,7 @@ async function handleReinit(cwd, options, developerName, pythonCmd) {
|
|
|
629
622
|
if (!doAddPlatforms && !doAddDeveloper) {
|
|
630
623
|
if (options.yes) {
|
|
631
624
|
console.log(chalk.gray(`Already initialized with: ${configuredNames}`));
|
|
632
|
-
console.log(chalk.gray("Use platform flags (e.g., --
|
|
625
|
+
console.log(chalk.gray("Use platform flags (e.g., --cursor) or -u <name> to add platforms/developer."));
|
|
633
626
|
return true;
|
|
634
627
|
}
|
|
635
628
|
console.log(chalk.gray(`\n Already initialized with: ${configuredNames}\n`));
|