@fernado03/zoo-flow 0.7.0 → 0.7.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 +13 -33
- package/package.json +1 -1
- package/templates/full/.roo/commands/explore.md +2 -2
- package/templates/full/.roo/commands/update-docs.md +1 -1
- package/templates/full/.roo/rules-code-tweaker/01-completion.md +3 -1
- package/templates/full/.roo/rules-custom-orchestrator/00-routing.md +21 -3
- package/templates/full/.roo/rules-system-architect/02-completion.md +1 -1
- package/templates/full/.zoo-flow/START_HERE.md +8 -61
package/README.md
CHANGED
|
@@ -53,36 +53,20 @@ npx @fernado03/zoo-flow@latest doctor
|
|
|
53
53
|
|
|
54
54
|
## Using Zoo Flow
|
|
55
55
|
|
|
56
|
-
First run:
|
|
57
|
-
|
|
58
|
-
-
|
|
59
|
-
- Run `/scaffold-context` when the project needs local context docs.
|
|
56
|
+
First run:
|
|
57
|
+
|
|
58
|
+
- Run `/scaffold-context` when the project needs local context docs.
|
|
60
59
|
- Run `/setup-matt-pocock-skills` when tracker or triage config is needed.
|
|
61
60
|
|
|
62
|
-
Daily use:
|
|
63
|
-
|
|
64
|
-
- Start in `custom-orchestrator
|
|
65
|
-
-
|
|
66
|
-
-
|
|
67
|
-
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
- Type a slash command directly when you already know the workflow.
|
|
72
|
-
- Zoo Code switches mode from the command file's `mode:` field.
|
|
73
|
-
|
|
74
|
-
Safety:
|
|
75
|
-
|
|
76
|
-
- Workflow choices must be plain language.
|
|
77
|
-
- Clickable choices must not include slash commands or mode names.
|
|
78
|
-
- Explicit slash commands count as approval.
|
|
79
|
-
- Free-form requests do not self-approve.
|
|
80
|
-
|
|
81
|
-
When Zoo Flow asks a workflow question, reply by typing the number, for
|
|
82
|
-
example `1`. See
|
|
83
|
-
[`docs/troubleshooting.md`](docs/troubleshooting.md#clickable-suggestions-can-route-incorrectly).
|
|
84
|
-
|
|
85
|
-
For team usage and deciding what to commit, see `docs/team-mode.md`.
|
|
61
|
+
Daily use:
|
|
62
|
+
|
|
63
|
+
- Start in `custom-orchestrator`, describe the task normally.
|
|
64
|
+
- The orchestrator proposes a plain-language workflow; approve by number.
|
|
65
|
+
- Or type a slash command directly (`/tweak`, `/fix`, etc.) to bypass routing.
|
|
66
|
+
- Explicit slash commands count as approval. Free-form requests do not.
|
|
67
|
+
- **Clickable choices must not include slash commands or mode names.**
|
|
68
|
+
|
|
69
|
+
For team usage, see `docs/team-mode.md`.
|
|
86
70
|
|
|
87
71
|
## Update
|
|
88
72
|
|
|
@@ -94,13 +78,9 @@ Backs up your current `.roomodes` and `.roo/` to
|
|
|
94
78
|
`.zoo-flow-backup/<timestamp>/`, then replaces them with the latest
|
|
95
79
|
template. Preview with `--dry-run`.
|
|
96
80
|
|
|
97
|
-
## Context economy
|
|
98
|
-
|
|
99
|
-
Zoo Flow avoids unnecessary token use by asking agents to search or list before broad reads, use targeted line ranges when possible, and avoid re-reading unchanged files. Full-file reads are still allowed when correctness requires complete context.
|
|
100
|
-
|
|
101
81
|
## Token discipline
|
|
102
82
|
|
|
103
|
-
Domain docs (`.zoo-flow/CONTEXT.md`, `.zoo-flow/docs/adr/`) are never read by default
|
|
83
|
+
Zoo Flow keeps always-loaded rules small. Domain docs (`.zoo-flow/CONTEXT.md`, `.zoo-flow/docs/adr/`) are never read by default — only when the task touches domain language, public behavior, or architecture seams. Agents search before broad reads, use targeted line ranges when possible, and avoid re-reading unchanged files. All runtime files have tiered token budgets enforced by `scripts/token-budget.js`.
|
|
104
84
|
|
|
105
85
|
## Modes
|
|
106
86
|
|
package/package.json
CHANGED
|
@@ -4,10 +4,10 @@ argument-hint: <feature or folder to map>
|
|
|
4
4
|
mode: system-architect
|
|
5
5
|
---
|
|
6
6
|
EXECUTION RULES:
|
|
7
|
-
1.
|
|
7
|
+
1. READ `.zoo-flow/CONTEXT.md`. If it does not exist, output one line before step 2: "No CONTEXT.md found. Run /scaffold-context to fill, or continue without." Do not invent content.
|
|
8
8
|
2. RUN skill: `.roo/skills/engineering/zoom-out/SKILL.md`.
|
|
9
9
|
3. OUTPUT MAP: Create markdown with sections: Domain language, Modules, Data flow, Seams/callers, ADRs, Open questions.
|
|
10
|
-
4. NEXT STEPS: Suggest `/
|
|
10
|
+
4. NEXT STEPS: Suggest `/scaffold-context`, `/feature`, `/refactor`, or `/fix`. DO NOT auto-launch.
|
|
11
11
|
5. SAVE (Optional): Ask to save map to .scratch/explorations/<date>/explore-<slug>.md.
|
|
12
12
|
|
|
13
13
|
$ARGUMENTS
|
|
@@ -8,7 +8,7 @@ Update repo documentation so it matches the current code. Surgical edits only
|
|
|
8
8
|
|
|
9
9
|
Skill: `.roo/skills/engineering/update-docs/SKILL.md`
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Find the target doc in `.zoo-flow/` or `docs/`. If it does not exist, ask once: "No <slot> found. Create a stub at .zoo-flow/<slot>? (yes / pick-existing / skip)".
|
|
12
12
|
|
|
13
13
|
Do NOT use this for:
|
|
14
14
|
|
|
@@ -18,7 +18,9 @@ Before any `attempt_completion`, re-read the command body and confirm no later p
|
|
|
18
18
|
- commands/tests run (exact commands, pass/fail per command)
|
|
19
19
|
- status (complete / partial / blocked with reason)
|
|
20
20
|
- remaining risk (what was not checked or is uncertain)
|
|
21
|
-
- recommended next command (one only, no auto-launch)
|
|
21
|
+
- recommended next command (one only, no auto-launch)
|
|
22
|
+
|
|
23
|
+
The orchestrator forwards your output to the user. Include enough detail that the user can act on it without re-running commands.
|
|
22
24
|
|
|
23
25
|
Before running `git commit` or `git push`, halt and wait for explicit user approval. Never push unless explicitly asked.
|
|
24
26
|
|
|
@@ -1,22 +1,40 @@
|
|
|
1
1
|
# Orchestrator Routing
|
|
2
2
|
|
|
3
|
-
Router only. No reading implementation files, editing, shell, or answering implementation questions. Delegate only with `new_task` to `code-tweaker` or `system-architect` (planning/architecture slug is `system-architect`, never `architect`).
|
|
3
|
+
Router only. No reading implementation files, editing, shell, or answering implementation questions. Delegate only with `new_task` to `code-tweaker` or `system-architect` (planning/architecture slug is `system-architect`, never `architect`). When a subtask returns, present its full result to the user first, then add one-line recommendation. Do not summarize away detail. Do not auto-launch another command.
|
|
4
|
+
|
|
5
|
+
## Subtask result handling
|
|
6
|
+
|
|
7
|
+
After `attempt_completion` from a worker, the orchestrator must:
|
|
8
|
+
|
|
9
|
+
1. Show the worker's full output to the user without truncating or summarizing.
|
|
10
|
+
2. Add one line: recommended next command (if any).
|
|
11
|
+
3. Stop and wait for user input.
|
|
12
|
+
|
|
13
|
+
Do not route a new user message until the previous subtask result is fully presented. If the user sends a new message before the result was shown, finish presenting the result first, then route the new message.
|
|
4
14
|
|
|
5
15
|
## Hard delegation boundary
|
|
6
16
|
|
|
7
|
-
|
|
17
|
+
For free-form requests, the only valid `new_task` target slugs are:
|
|
8
18
|
|
|
9
19
|
- `code-tweaker`
|
|
10
20
|
- `system-architect`
|
|
11
21
|
|
|
12
22
|
Never delegate to built-in/default modes, including Ask, Code, Debug, Architect, or Orchestrator.
|
|
13
23
|
|
|
24
|
+
Slash commands bypass this — the extension reads `mode:` from the command frontmatter and switches directly.
|
|
25
|
+
|
|
14
26
|
If a task sounds like "ask", "inspect", "review", "branch review", "pre-commit review", "analyze", "deep inspection", "investigate", or "reason about safety", route it to `system-architect`.
|
|
15
27
|
|
|
16
28
|
If a task requires source edits, tests, verification, docs updates, prototypes, or commits, route it to `code-tweaker`.
|
|
17
29
|
|
|
18
30
|
If neither custom mode is suitable, stop and report that no valid Zoo Flow mode exists. Do not fall back to Ask mode.
|
|
19
31
|
|
|
32
|
+
## Slash command handling
|
|
33
|
+
|
|
34
|
+
When the user types a slash command (e.g. `/tweak`, `/explore`), the extension reads the `mode:` frontmatter from the command file and auto-switches to that mode. The orchestrator does not route slash commands — the extension handles it.
|
|
35
|
+
|
|
36
|
+
The orchestrator only routes **free-form requests** (natural language without a leading `/`).
|
|
37
|
+
|
|
20
38
|
## Natural language first
|
|
21
39
|
|
|
22
40
|
Users are not expected to know slash commands. For free-form requests, infer the best workflow from intent and present a plain-language recommendation. Slash commands are optional power-user overrides. Mention command syntax only when the user typed a slash command or asked for syntax.
|
|
@@ -64,7 +82,7 @@ Explicit slash command from user = approval; route as-is. Clear free-form reques
|
|
|
64
82
|
|
|
65
83
|
## Approval gate
|
|
66
84
|
|
|
67
|
-
The orchestrator proposes; the user approves; then the orchestrator delegates.
|
|
85
|
+
The orchestrator proposes; the user approves; then the orchestrator delegates. Slash commands are auto-approved — the extension switches mode and executes immediately. A free-form request is never self-approving; propose a workflow and wait for approval. Present the recommendation, then stop and wait. Treat replies as approval only when they select the proposed workflow by number, option text, or clear restatement. A fresh free-form request restarts routing. If unsure whether the user approved, ask.
|
|
68
86
|
|
|
69
87
|
## Delegation
|
|
70
88
|
|
|
@@ -11,7 +11,7 @@ If you entered this window via `switch_mode` (you are mid-chain, not the entry p
|
|
|
11
11
|
|
|
12
12
|
Before any `attempt_completion`, re-read the command body and confirm no later phase is assigned to another mode. If one is, `switch_mode` instead.
|
|
13
13
|
|
|
14
|
-
Do not use `attempt_completion` to avoid required implementation work. Every `attempt_completion` must include
|
|
14
|
+
Do not use `attempt_completion` to avoid required implementation work. Every `attempt_completion` must include the full output the user needs to see (review findings, exploration map, diagnosis, plan), not just summaries. The orchestrator will forward your output to the user; if you summarize, the user loses detail.
|
|
15
15
|
|
|
16
16
|
Halt for explicit user approval before testing a bug hypothesis, finalizing an architecture plan, publishing issues, or making irreversible decisions.
|
|
17
17
|
|
|
@@ -1,61 +1,8 @@
|
|
|
1
|
-
# Zoo Flow Quick Start
|
|
2
|
-
|
|
3
|
-
## After installation
|
|
4
|
-
|
|
5
|
-
1.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
`/scaffold-context`
|
|
10
|
-
|
|
11
|
-
This scans the codebase and proposes initial `.zoo-flow/CONTEXT.md` terms plus optional starter ADRs. It asks before writing anything.
|
|
12
|
-
|
|
13
|
-
3. If you plan to use PRDs, issue slicing, or triage, configure agent skill metadata:
|
|
14
|
-
|
|
15
|
-
`/setup-matt-pocock-skills`
|
|
16
|
-
|
|
17
|
-
This sets up issue tracker, triage label, and domain-doc configuration used by PRD, issue, and triage workflows.
|
|
18
|
-
|
|
19
|
-
4. After that, describe tasks normally. You do not need slash commands unless you already know the workflow.
|
|
20
|
-
|
|
21
|
-
## First-run checklist
|
|
22
|
-
|
|
23
|
-
- [ ] Custom Orchestrator mode is selected.
|
|
24
|
-
- [ ] Run `/scaffold-context` for an existing codebase.
|
|
25
|
-
- [ ] Run `/setup-matt-pocock-skills` if using PRDs, issue slicing, or triage.
|
|
26
|
-
- [ ] Start normal work by describing the task in plain language.
|
|
27
|
-
|
|
28
|
-
## Common requests
|
|
29
|
-
|
|
30
|
-
| What you want | What Zoo Flow will likely do |
|
|
31
|
-
|---|---|
|
|
32
|
-
| Small obvious edit | Small implementation workflow |
|
|
33
|
-
| Known localized fix | Small implementation workflow |
|
|
34
|
-
| Bug with unknown cause | Diagnosis workflow |
|
|
35
|
-
| New feature needing planning | Feature planning workflow |
|
|
36
|
-
| Improve structure without behavior change | Refactor workflow |
|
|
37
|
-
| Understand unfamiliar area | Exploration workflow |
|
|
38
|
-
| Write tests first | TDD workflow |
|
|
39
|
-
| Update docs | Documentation workflow |
|
|
40
|
-
| Commit finished work | Commit + journal workflow |
|
|
41
|
-
|
|
42
|
-
## What the orchestrator will show you
|
|
43
|
-
|
|
44
|
-
For normal requests, the orchestrator should recommend plain-language workflows, not slash commands.
|
|
45
|
-
|
|
46
|
-
Example:
|
|
47
|
-
|
|
48
|
-
> "This looks like a small implementation change. Proceed?"
|
|
49
|
-
|
|
50
|
-
Slash commands below are optional shortcuts for users who already know the workflow.
|
|
51
|
-
|
|
52
|
-
## Power-user shortcuts
|
|
53
|
-
|
|
54
|
-
You may type slash commands directly when you already know the workflow, but this is optional.
|
|
55
|
-
|
|
56
|
-
Examples:
|
|
57
|
-
|
|
58
|
-
- `/tweak change button copy`
|
|
59
|
-
- `/fix checkout crashes after payment`
|
|
60
|
-
- `/feature add team invitations`
|
|
61
|
-
- `/refactor simplify auth service`
|
|
1
|
+
# Zoo Flow Quick Start
|
|
2
|
+
|
|
3
|
+
## After installation
|
|
4
|
+
|
|
5
|
+
1. Reload VS Code and open Zoo Code.
|
|
6
|
+
2. Switch to **Custom Orchestrator** mode.
|
|
7
|
+
3. Run `/scaffold-context` for an existing project, or `/setup-matt-pocock-skills` if using PRDs, issue slicing, or triage.
|
|
8
|
+
4. Then describe tasks normally.
|