@bradygaster/squad-cli 0.7.0 → 0.8.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 +77 -77
- package/dist/cli/commands/copilot.d.ts +13 -0
- package/dist/cli/commands/copilot.d.ts.map +1 -0
- package/dist/cli/commands/copilot.js +86 -0
- package/dist/cli/commands/copilot.js.map +1 -0
- package/dist/cli/commands/export.d.ts +9 -0
- package/dist/cli/commands/export.d.ts.map +1 -0
- package/dist/cli/commands/export.js +89 -0
- package/dist/cli/commands/export.js.map +1 -0
- package/dist/cli/commands/import.d.ts +9 -0
- package/dist/cli/commands/import.d.ts.map +1 -0
- package/dist/cli/commands/import.js +116 -0
- package/dist/cli/commands/import.js.map +1 -0
- package/dist/cli/commands/plugin.d.ts +14 -0
- package/dist/cli/commands/plugin.d.ts.map +1 -0
- package/dist/cli/commands/plugin.js +134 -0
- package/dist/cli/commands/plugin.js.map +1 -0
- package/dist/cli/commands/watch.d.ts +8 -0
- package/dist/cli/commands/watch.d.ts.map +1 -0
- package/dist/cli/commands/watch.js +178 -0
- package/dist/cli/commands/watch.js.map +1 -0
- package/dist/cli/copilot-install.d.ts +73 -0
- package/dist/cli/copilot-install.d.ts.map +1 -0
- package/dist/cli/copilot-install.js +117 -0
- package/dist/cli/copilot-install.js.map +1 -0
- package/dist/cli/core/detect-squad-dir.d.ts +13 -0
- package/dist/cli/core/detect-squad-dir.d.ts.map +1 -0
- package/dist/cli/core/detect-squad-dir.js +21 -0
- package/dist/cli/core/detect-squad-dir.js.map +1 -0
- package/dist/cli/core/email-scrub.d.ts +10 -0
- package/dist/cli/core/email-scrub.d.ts.map +1 -0
- package/dist/cli/core/email-scrub.js +103 -0
- package/dist/cli/core/email-scrub.js.map +1 -0
- package/dist/cli/core/errors.d.ts +17 -0
- package/dist/cli/core/errors.d.ts.map +1 -0
- package/dist/cli/core/errors.js +22 -0
- package/dist/cli/core/errors.js.map +1 -0
- package/dist/cli/core/gh-cli.d.ts +41 -0
- package/dist/cli/core/gh-cli.d.ts.map +1 -0
- package/dist/cli/core/gh-cli.js +67 -0
- package/dist/cli/core/gh-cli.js.map +1 -0
- package/dist/cli/core/history-split.d.ts +9 -0
- package/dist/cli/core/history-split.d.ts.map +1 -0
- package/dist/cli/core/history-split.js +65 -0
- package/dist/cli/core/history-split.js.map +1 -0
- package/dist/cli/core/init.d.ts +9 -0
- package/dist/cli/core/init.d.ts.map +1 -0
- package/dist/cli/core/init.js +296 -0
- package/dist/cli/core/init.js.map +1 -0
- package/dist/cli/core/migrate-directory.d.ts +11 -0
- package/dist/cli/core/migrate-directory.d.ts.map +1 -0
- package/dist/cli/core/migrate-directory.js +71 -0
- package/dist/cli/core/migrate-directory.js.map +1 -0
- package/dist/cli/core/migrations.d.ts +11 -0
- package/dist/cli/core/migrations.d.ts.map +1 -0
- package/dist/cli/core/migrations.js +78 -0
- package/dist/cli/core/migrations.js.map +1 -0
- package/dist/cli/core/output.d.ts +34 -0
- package/dist/cli/core/output.d.ts.map +1 -0
- package/dist/cli/core/output.js +47 -0
- package/dist/cli/core/output.js.map +1 -0
- package/dist/cli/core/project-type.d.ts +9 -0
- package/dist/cli/core/project-type.d.ts.map +1 -0
- package/dist/cli/core/project-type.js +29 -0
- package/dist/cli/core/project-type.js.map +1 -0
- package/dist/cli/core/team-md.d.ts +28 -0
- package/dist/cli/core/team-md.d.ts.map +1 -0
- package/dist/cli/core/team-md.js +91 -0
- package/dist/cli/core/team-md.js.map +1 -0
- package/dist/cli/core/templates.d.ts +30 -0
- package/dist/cli/core/templates.d.ts.map +1 -0
- package/dist/cli/core/templates.js +247 -0
- package/dist/cli/core/templates.js.map +1 -0
- package/dist/cli/core/upgrade.d.ts +20 -0
- package/dist/cli/core/upgrade.d.ts.map +1 -0
- package/dist/cli/core/upgrade.js +399 -0
- package/dist/cli/core/upgrade.js.map +1 -0
- package/dist/cli/core/version.d.ts +18 -0
- package/dist/cli/core/version.d.ts.map +1 -0
- package/dist/cli/core/version.js +61 -0
- package/dist/cli/core/version.js.map +1 -0
- package/dist/cli/core/workflows.d.ts +10 -0
- package/dist/cli/core/workflows.d.ts.map +1 -0
- package/dist/cli/core/workflows.js +155 -0
- package/dist/cli/core/workflows.js.map +1 -0
- package/dist/cli/index.d.ts +26 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +26 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/shell/autocomplete.d.ts +12 -0
- package/dist/cli/shell/autocomplete.d.ts.map +1 -0
- package/dist/cli/shell/autocomplete.js +39 -0
- package/dist/cli/shell/autocomplete.js.map +1 -0
- package/dist/cli/shell/commands.d.ts +19 -0
- package/dist/cli/shell/commands.d.ts.map +1 -0
- package/dist/cli/shell/commands.js +87 -0
- package/dist/cli/shell/commands.js.map +1 -0
- package/dist/cli/shell/components/AgentPanel.d.ts +8 -0
- package/dist/cli/shell/components/AgentPanel.d.ts.map +1 -0
- package/dist/cli/shell/components/AgentPanel.js +17 -0
- package/dist/cli/shell/components/AgentPanel.js.map +1 -0
- package/dist/cli/shell/components/InputPrompt.d.ts +9 -0
- package/dist/cli/shell/components/InputPrompt.d.ts.map +1 -0
- package/dist/cli/shell/components/InputPrompt.js +50 -0
- package/dist/cli/shell/components/InputPrompt.js.map +1 -0
- package/dist/cli/shell/components/MessageStream.d.ts +13 -0
- package/dist/cli/shell/components/MessageStream.d.ts.map +1 -0
- package/dist/cli/shell/components/MessageStream.js +7 -0
- package/dist/cli/shell/components/MessageStream.js.map +1 -0
- package/dist/cli/shell/components/index.d.ts +4 -0
- package/dist/cli/shell/components/index.d.ts.map +1 -0
- package/dist/cli/shell/components/index.js +4 -0
- package/dist/cli/shell/components/index.js.map +1 -0
- package/dist/cli/shell/coordinator.d.ts +32 -0
- package/dist/cli/shell/coordinator.d.ts.map +1 -0
- package/dist/cli/shell/coordinator.js +113 -0
- package/dist/cli/shell/coordinator.js.map +1 -0
- package/dist/cli/shell/index.d.ts +28 -0
- package/dist/cli/shell/index.d.ts.map +1 -0
- package/dist/cli/shell/index.js +66 -0
- package/dist/cli/shell/index.js.map +1 -0
- package/dist/cli/shell/lifecycle.d.ts +52 -0
- package/dist/cli/shell/lifecycle.d.ts.map +1 -0
- package/dist/cli/shell/lifecycle.js +168 -0
- package/dist/cli/shell/lifecycle.js.map +1 -0
- package/dist/cli/shell/memory.d.ts +36 -0
- package/dist/cli/shell/memory.d.ts.map +1 -0
- package/dist/cli/shell/memory.js +53 -0
- package/dist/cli/shell/memory.js.map +1 -0
- package/dist/cli/shell/render.d.ts +22 -0
- package/dist/cli/shell/render.d.ts.map +1 -0
- package/dist/cli/shell/render.js +44 -0
- package/dist/cli/shell/render.js.map +1 -0
- package/dist/cli/shell/router.d.ts +17 -0
- package/dist/cli/shell/router.d.ts.map +1 -0
- package/dist/cli/shell/router.js +55 -0
- package/dist/cli/shell/router.js.map +1 -0
- package/dist/cli/shell/sessions.d.ts +15 -0
- package/dist/cli/shell/sessions.d.ts.map +1 -0
- package/dist/cli/shell/sessions.js +37 -0
- package/dist/cli/shell/sessions.js.map +1 -0
- package/dist/cli/shell/spawn.d.ts +47 -0
- package/dist/cli/shell/spawn.d.ts.map +1 -0
- package/dist/cli/shell/spawn.js +77 -0
- package/dist/cli/shell/spawn.js.map +1 -0
- package/dist/cli/shell/stream-bridge.d.ts +60 -0
- package/dist/cli/shell/stream-bridge.d.ts.map +1 -0
- package/dist/cli/shell/stream-bridge.js +98 -0
- package/dist/cli/shell/stream-bridge.js.map +1 -0
- package/dist/cli/shell/terminal.d.ts +30 -0
- package/dist/cli/shell/terminal.d.ts.map +1 -0
- package/dist/cli/shell/terminal.js +34 -0
- package/dist/cli/shell/terminal.js.map +1 -0
- package/dist/cli/shell/types.d.ts +21 -0
- package/dist/cli/shell/types.d.ts.map +1 -0
- package/dist/cli/shell/types.js +5 -0
- package/dist/cli/shell/types.js.map +1 -0
- package/dist/cli/upgrade.d.ts +141 -0
- package/dist/cli/upgrade.d.ts.map +1 -0
- package/dist/cli/upgrade.js +226 -0
- package/dist/cli/upgrade.js.map +1 -0
- package/dist/cli-entry.d.ts +10 -0
- package/dist/cli-entry.d.ts.map +1 -0
- package/dist/cli-entry.js +213 -0
- package/dist/cli-entry.js.map +1 -0
- package/dist/cli.js +2 -2
- package/package.json +45 -34
- package/templates/casting-history.json +4 -0
- package/templates/casting-policy.json +35 -0
- package/templates/casting-registry.json +3 -0
- package/templates/ceremonies.md +41 -0
- package/templates/charter.md +53 -0
- package/templates/constraint-tracking.md +38 -0
- package/templates/copilot-instructions.md +46 -0
- package/templates/history.md +10 -0
- package/templates/identity/now.md +9 -0
- package/templates/identity/wisdom.md +15 -0
- package/templates/mcp-config.md +90 -0
- package/templates/multi-agent-format.md +28 -0
- package/templates/orchestration-log.md +27 -0
- package/templates/plugin-marketplace.md +49 -0
- package/templates/raw-agent-output.md +37 -0
- package/templates/roster.md +60 -0
- package/templates/routing.md +54 -0
- package/templates/run-output.md +50 -0
- package/templates/scribe-charter.md +119 -0
- package/templates/skill.md +24 -0
- package/templates/skills/squad-conventions/SKILL.md +69 -0
- package/templates/squad.agent.md +1146 -0
- package/templates/workflows/squad-ci.yml +24 -0
- package/templates/workflows/squad-docs.yml +50 -0
- package/templates/workflows/squad-heartbeat.yml +315 -0
- package/templates/workflows/squad-insider-release.yml +61 -0
- package/templates/workflows/squad-issue-assign.yml +161 -0
- package/templates/workflows/squad-label-enforce.yml +181 -0
- package/templates/workflows/squad-main-guard.yml +129 -0
- package/templates/workflows/squad-preview.yml +55 -0
- package/templates/workflows/squad-promote.yml +121 -0
- package/templates/workflows/squad-release.yml +77 -0
- package/templates/workflows/squad-triage.yml +260 -0
- package/templates/workflows/sync-squad-labels.yml +169 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Team Roster
|
|
2
|
+
|
|
3
|
+
> {One-line project description}
|
|
4
|
+
|
|
5
|
+
## Coordinator
|
|
6
|
+
|
|
7
|
+
| Name | Role | Notes |
|
|
8
|
+
|------|------|-------|
|
|
9
|
+
| Squad | Coordinator | Routes work, enforces handoffs and reviewer gates. Does not generate domain artifacts. |
|
|
10
|
+
|
|
11
|
+
## Members
|
|
12
|
+
|
|
13
|
+
| Name | Role | Charter | Status |
|
|
14
|
+
|------|------|---------|--------|
|
|
15
|
+
| {Name} | {Role} | `.squad/agents/{name}/charter.md` | ✅ Active |
|
|
16
|
+
| {Name} | {Role} | `.squad/agents/{name}/charter.md` | ✅ Active |
|
|
17
|
+
| {Name} | {Role} | `.squad/agents/{name}/charter.md` | ✅ Active |
|
|
18
|
+
| {Name} | {Role} | `.squad/agents/{name}/charter.md` | ✅ Active |
|
|
19
|
+
| Scribe | Session Logger | `.squad/agents/scribe/charter.md` | 📋 Silent |
|
|
20
|
+
| Ralph | Work Monitor | — | 🔄 Monitor |
|
|
21
|
+
|
|
22
|
+
## Coding Agent
|
|
23
|
+
|
|
24
|
+
<!-- copilot-auto-assign: false -->
|
|
25
|
+
|
|
26
|
+
| Name | Role | Charter | Status |
|
|
27
|
+
|------|------|---------|--------|
|
|
28
|
+
| @copilot | Coding Agent | — | 🤖 Coding Agent |
|
|
29
|
+
|
|
30
|
+
### Capabilities
|
|
31
|
+
|
|
32
|
+
**🟢 Good fit — auto-route when enabled:**
|
|
33
|
+
- Bug fixes with clear reproduction steps
|
|
34
|
+
- Test coverage (adding missing tests, fixing flaky tests)
|
|
35
|
+
- Lint/format fixes and code style cleanup
|
|
36
|
+
- Dependency updates and version bumps
|
|
37
|
+
- Small isolated features with clear specs
|
|
38
|
+
- Boilerplate/scaffolding generation
|
|
39
|
+
- Documentation fixes and README updates
|
|
40
|
+
|
|
41
|
+
**🟡 Needs review — route to @copilot but flag for squad member PR review:**
|
|
42
|
+
- Medium features with clear specs and acceptance criteria
|
|
43
|
+
- Refactoring with existing test coverage
|
|
44
|
+
- API endpoint additions following established patterns
|
|
45
|
+
- Migration scripts with well-defined schemas
|
|
46
|
+
|
|
47
|
+
**🔴 Not suitable — route to squad member instead:**
|
|
48
|
+
- Architecture decisions and system design
|
|
49
|
+
- Multi-system integration requiring coordination
|
|
50
|
+
- Ambiguous requirements needing clarification
|
|
51
|
+
- Security-critical changes (auth, encryption, access control)
|
|
52
|
+
- Performance-critical paths requiring benchmarking
|
|
53
|
+
- Changes requiring cross-team discussion
|
|
54
|
+
|
|
55
|
+
## Project Context
|
|
56
|
+
|
|
57
|
+
- **Owner:** {user name}
|
|
58
|
+
- **Stack:** {languages, frameworks, tools}
|
|
59
|
+
- **Description:** {what the project does, in one sentence}
|
|
60
|
+
- **Created:** {timestamp}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Work Routing
|
|
2
|
+
|
|
3
|
+
How to decide who handles what.
|
|
4
|
+
|
|
5
|
+
## Routing Table
|
|
6
|
+
|
|
7
|
+
| Work Type | Route To | Examples |
|
|
8
|
+
|-----------|----------|----------|
|
|
9
|
+
| {domain 1} | {Name} | {example tasks} |
|
|
10
|
+
| {domain 2} | {Name} | {example tasks} |
|
|
11
|
+
| {domain 3} | {Name} | {example tasks} |
|
|
12
|
+
| Code review | {Name} | Review PRs, check quality, suggest improvements |
|
|
13
|
+
| Testing | {Name} | Write tests, find edge cases, verify fixes |
|
|
14
|
+
| Scope & priorities | {Name} | What to build next, trade-offs, decisions |
|
|
15
|
+
| Async issue work (bugs, tests, small features) | @copilot 🤖 | Well-defined tasks matching capability profile |
|
|
16
|
+
| Session logging | Scribe | Automatic — never needs routing |
|
|
17
|
+
|
|
18
|
+
## Issue Routing
|
|
19
|
+
|
|
20
|
+
| Label | Action | Who |
|
|
21
|
+
|-------|--------|-----|
|
|
22
|
+
| `squad` | Triage: analyze issue, evaluate @copilot fit, assign `squad:{member}` label | Lead |
|
|
23
|
+
| `squad:{name}` | Pick up issue and complete the work | Named member |
|
|
24
|
+
| `squad:copilot` | Assign to @copilot for autonomous work (if enabled) | @copilot 🤖 |
|
|
25
|
+
|
|
26
|
+
### How Issue Assignment Works
|
|
27
|
+
|
|
28
|
+
1. When a GitHub issue gets the `squad` label, the **Lead** triages it — analyzing content, evaluating @copilot's capability profile, assigning the right `squad:{member}` label, and commenting with triage notes.
|
|
29
|
+
2. **@copilot evaluation:** The Lead checks if the issue matches @copilot's capability profile (🟢 good fit / 🟡 needs review / 🔴 not suitable). If it's a good fit, the Lead may route to `squad:copilot` instead of a squad member.
|
|
30
|
+
3. When a `squad:{member}` label is applied, that member picks up the issue in their next session.
|
|
31
|
+
4. When `squad:copilot` is applied and auto-assign is enabled, `@copilot` is assigned on the issue and picks it up autonomously.
|
|
32
|
+
5. Members can reassign by removing their label and adding another member's label.
|
|
33
|
+
6. The `squad` label is the "inbox" — untriaged issues waiting for Lead review.
|
|
34
|
+
|
|
35
|
+
### Lead Triage Guidance for @copilot
|
|
36
|
+
|
|
37
|
+
When triaging, the Lead should ask:
|
|
38
|
+
|
|
39
|
+
1. **Is this well-defined?** Clear title, reproduction steps or acceptance criteria, bounded scope → likely 🟢
|
|
40
|
+
2. **Does it follow existing patterns?** Adding a test, fixing a known bug, updating a dependency → likely 🟢
|
|
41
|
+
3. **Does it need design judgment?** Architecture, API design, UX decisions → likely 🔴
|
|
42
|
+
4. **Is it security-sensitive?** Auth, encryption, access control → always 🔴
|
|
43
|
+
5. **Is it medium complexity with specs?** Feature with clear requirements, refactoring with tests → likely 🟡
|
|
44
|
+
|
|
45
|
+
## Rules
|
|
46
|
+
|
|
47
|
+
1. **Eager by default** — spawn all agents who could usefully start work, including anticipatory downstream work.
|
|
48
|
+
2. **Scribe always runs** after substantial work, always as `mode: "background"`. Never blocks.
|
|
49
|
+
3. **Quick facts → coordinator answers directly.** Don't spawn an agent for "what port does the server run on?"
|
|
50
|
+
4. **When two agents could handle it**, pick the one whose domain is the primary concern.
|
|
51
|
+
5. **"Team, ..." → fan-out.** Spawn all relevant agents in parallel as `mode: "background"`.
|
|
52
|
+
6. **Anticipate downstream work.** If a feature is being built, spawn the tester to write test cases from requirements simultaneously.
|
|
53
|
+
7. **Issue-labeled work** — when a `squad:{member}` label is applied to an issue, route to that member. The Lead handles all `squad` (base label) triage.
|
|
54
|
+
8. **@copilot routing** — when evaluating issues, check @copilot's capability profile in `team.md`. Route 🟢 good-fit tasks to `squad:copilot`. Flag 🟡 needs-review tasks for PR review. Keep 🔴 not-suitable tasks with squad members.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Run Output — {task title}
|
|
2
|
+
|
|
3
|
+
> Final assembled artifact from a multi-agent run.
|
|
4
|
+
|
|
5
|
+
## Termination Condition
|
|
6
|
+
|
|
7
|
+
**Reason:** {One of: User accepted | Reviewer approved | Constraint budget exhausted | Deadlock — escalated to user | User cancelled}
|
|
8
|
+
|
|
9
|
+
## Constraint Budgets
|
|
10
|
+
|
|
11
|
+
<!-- Track all active constraints inline. Remove this section if no constraints are active. -->
|
|
12
|
+
|
|
13
|
+
| Constraint | Used | Max | Status |
|
|
14
|
+
|------------|------|-----|--------|
|
|
15
|
+
| Clarifying questions | 📊 {n} | {max} | {Active / Exhausted} |
|
|
16
|
+
| Revision cycles | 📊 {n} | {max} | {Active / Exhausted} |
|
|
17
|
+
|
|
18
|
+
## Result
|
|
19
|
+
|
|
20
|
+
{Assembled final artifact goes here. This is the Coordinator's synthesis of agent outputs.}
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Reviewer Verdict
|
|
25
|
+
|
|
26
|
+
<!-- Include one block per review. Remove this section if no review occurred. -->
|
|
27
|
+
|
|
28
|
+
### Review by {Name} ({Role})
|
|
29
|
+
|
|
30
|
+
| Field | Value |
|
|
31
|
+
|-------|-------|
|
|
32
|
+
| **Verdict** | {Approved / Rejected} |
|
|
33
|
+
| **What's wrong** | {Specific issue — not vague} |
|
|
34
|
+
| **Why it matters** | {Impact if not fixed} |
|
|
35
|
+
| **Who fixes it** | {Name of agent assigned to revise — MUST NOT be the original author} |
|
|
36
|
+
| **Revision budget** | 📊 {used} / {max} revision cycles remaining |
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## APPENDIX: RAW AGENT OUTPUTS
|
|
41
|
+
|
|
42
|
+
<!-- Paste each agent's verbatim response below. Do NOT edit, summarize, rewrite, or wrap in code fences. One section per agent. -->
|
|
43
|
+
|
|
44
|
+
### {Name} ({Role}) — Raw Output
|
|
45
|
+
|
|
46
|
+
{Paste agent's verbatim response here, unedited}
|
|
47
|
+
|
|
48
|
+
### {Name} ({Role}) — Raw Output
|
|
49
|
+
|
|
50
|
+
{Paste agent's verbatim response here, unedited}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Scribe
|
|
2
|
+
|
|
3
|
+
> The team's memory. Silent, always present, never forgets.
|
|
4
|
+
|
|
5
|
+
## Identity
|
|
6
|
+
|
|
7
|
+
- **Name:** Scribe
|
|
8
|
+
- **Role:** Session Logger, Memory Manager & Decision Merger
|
|
9
|
+
- **Style:** Silent. Never speaks to the user. Works in the background.
|
|
10
|
+
- **Mode:** Always spawned as `mode: "background"`. Never blocks the conversation.
|
|
11
|
+
|
|
12
|
+
## What I Own
|
|
13
|
+
|
|
14
|
+
- `.squad/log/` — session logs (what happened, who worked, what was decided)
|
|
15
|
+
- `.squad/decisions.md` — the shared decision log all agents read (canonical, merged)
|
|
16
|
+
- `.squad/decisions/inbox/` — decision drop-box (agents write here, I merge)
|
|
17
|
+
- Cross-agent context propagation — when one agent's decision affects another
|
|
18
|
+
|
|
19
|
+
## How I Work
|
|
20
|
+
|
|
21
|
+
**Worktree awareness:** Use the `TEAM ROOT` provided in the spawn prompt to resolve all `.squad/` paths. If no TEAM ROOT is given, run `git rev-parse --show-toplevel` as fallback. Do not assume CWD is the repo root (the session may be running in a worktree or subdirectory).
|
|
22
|
+
|
|
23
|
+
After every substantial work session:
|
|
24
|
+
|
|
25
|
+
1. **Log the session** to `.squad/log/{timestamp}-{topic}.md`:
|
|
26
|
+
- Who worked
|
|
27
|
+
- What was done
|
|
28
|
+
- Decisions made
|
|
29
|
+
- Key outcomes
|
|
30
|
+
- Brief. Facts only.
|
|
31
|
+
|
|
32
|
+
2. **Merge the decision inbox:**
|
|
33
|
+
- Read all files in `.squad/decisions/inbox/`
|
|
34
|
+
- APPEND each decision's contents to `.squad/decisions.md`
|
|
35
|
+
- Delete each inbox file after merging
|
|
36
|
+
|
|
37
|
+
3. **Deduplicate and consolidate decisions.md:**
|
|
38
|
+
- Parse the file into decision blocks (each block starts with `### `).
|
|
39
|
+
- **Exact duplicates:** If two blocks share the same heading, keep the first and remove the rest.
|
|
40
|
+
- **Overlapping decisions:** Compare block content across all remaining blocks. If two or more blocks cover the same area (same topic, same architectural concern, same component) but were written independently (different dates, different authors), consolidate them:
|
|
41
|
+
a. Synthesize a single merged block that combines the intent and rationale from all overlapping blocks.
|
|
42
|
+
b. Use today's date and a new heading: `### {today}: {consolidated topic} (consolidated)`
|
|
43
|
+
c. Credit all original authors: `**By:** {Name1}, {Name2}`
|
|
44
|
+
d. Under **What:**, combine the decisions. Note any differences or evolution.
|
|
45
|
+
e. Under **Why:**, merge the rationale, preserving unique reasoning from each.
|
|
46
|
+
f. Remove the original overlapping blocks.
|
|
47
|
+
- Write the updated file back. This handles duplicates and convergent decisions introduced by `merge=union` across branches.
|
|
48
|
+
|
|
49
|
+
4. **Propagate cross-agent updates:**
|
|
50
|
+
For any newly merged decision that affects other agents, append to their `history.md`:
|
|
51
|
+
```
|
|
52
|
+
📌 Team update ({timestamp}): {summary} — decided by {Name}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
5. **Commit `.squad/` changes:**
|
|
56
|
+
**IMPORTANT — Windows compatibility:** Do NOT use `git -C {path}` (unreliable with Windows paths).
|
|
57
|
+
Do NOT embed newlines in `git commit -m` (backtick-n fails silently in PowerShell).
|
|
58
|
+
Instead:
|
|
59
|
+
- `cd` into the team root first.
|
|
60
|
+
- Stage all `.squad/` files: `git add .squad/`
|
|
61
|
+
- Check for staged changes: `git diff --cached --quiet`
|
|
62
|
+
If exit code is 0, no changes — skip silently.
|
|
63
|
+
- Write the commit message to a temp file, then commit with `-F`:
|
|
64
|
+
```
|
|
65
|
+
$msg = @"
|
|
66
|
+
docs(ai-team): {brief summary}
|
|
67
|
+
|
|
68
|
+
Session: {timestamp}-{topic}
|
|
69
|
+
Requested by: {user name}
|
|
70
|
+
|
|
71
|
+
Changes:
|
|
72
|
+
- {what was logged}
|
|
73
|
+
- {what decisions were merged}
|
|
74
|
+
- {what decisions were deduplicated}
|
|
75
|
+
- {what cross-agent updates were propagated}
|
|
76
|
+
"@
|
|
77
|
+
$msgFile = [System.IO.Path]::GetTempFileName()
|
|
78
|
+
Set-Content -Path $msgFile -Value $msg -Encoding utf8
|
|
79
|
+
git commit -F $msgFile
|
|
80
|
+
Remove-Item $msgFile
|
|
81
|
+
```
|
|
82
|
+
- **Verify the commit landed:** Run `git log --oneline -1` and confirm the
|
|
83
|
+
output matches the expected message. If it doesn't, report the error.
|
|
84
|
+
|
|
85
|
+
6. **Never speak to the user.** Never appear in responses. Work silently.
|
|
86
|
+
|
|
87
|
+
## The Memory Architecture
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
.squad/
|
|
91
|
+
├── decisions.md # Shared brain — all agents read this (merged by Scribe)
|
|
92
|
+
├── decisions/
|
|
93
|
+
│ └── inbox/ # Drop-box — agents write decisions here in parallel
|
|
94
|
+
│ ├── river-jwt-auth.md
|
|
95
|
+
│ └── kai-component-lib.md
|
|
96
|
+
├── orchestration-log/ # Per-spawn log entries
|
|
97
|
+
│ ├── 2025-07-01T10-00-river.md
|
|
98
|
+
│ └── 2025-07-01T10-00-kai.md
|
|
99
|
+
├── log/ # Session history — searchable record
|
|
100
|
+
│ ├── 2025-07-01-setup.md
|
|
101
|
+
│ └── 2025-07-02-api.md
|
|
102
|
+
└── agents/
|
|
103
|
+
├── kai/history.md # Kai's personal knowledge
|
|
104
|
+
├── river/history.md # River's personal knowledge
|
|
105
|
+
└── ...
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
- **decisions.md** = what the team agreed on (shared, merged by Scribe)
|
|
109
|
+
- **decisions/inbox/** = where agents drop decisions during parallel work
|
|
110
|
+
- **history.md** = what each agent learned (personal)
|
|
111
|
+
- **log/** = what happened (archive)
|
|
112
|
+
|
|
113
|
+
## Boundaries
|
|
114
|
+
|
|
115
|
+
**I handle:** Logging, memory, decision merging, cross-agent updates.
|
|
116
|
+
|
|
117
|
+
**I don't handle:** Any domain work. I don't write code, review PRs, or make decisions.
|
|
118
|
+
|
|
119
|
+
**I am invisible.** If a user notices me, something went wrong.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "{skill-name}"
|
|
3
|
+
description: "{what this skill teaches agents}"
|
|
4
|
+
domain: "{e.g., testing, api-design, error-handling}"
|
|
5
|
+
confidence: "low|medium|high"
|
|
6
|
+
source: "{how this was learned: manual, observed, earned}"
|
|
7
|
+
tools:
|
|
8
|
+
# Optional — declare MCP tools relevant to this skill's patterns
|
|
9
|
+
# - name: "{tool-name}"
|
|
10
|
+
# description: "{what this tool does}"
|
|
11
|
+
# when: "{when to use this tool}"
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Context
|
|
15
|
+
{When and why this skill applies}
|
|
16
|
+
|
|
17
|
+
## Patterns
|
|
18
|
+
{Specific patterns, conventions, or approaches}
|
|
19
|
+
|
|
20
|
+
## Examples
|
|
21
|
+
{Code examples or references}
|
|
22
|
+
|
|
23
|
+
## Anti-Patterns
|
|
24
|
+
{What to avoid}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "squad-conventions"
|
|
3
|
+
description: "Core conventions and patterns used in the Squad codebase"
|
|
4
|
+
domain: "project-conventions"
|
|
5
|
+
confidence: "high"
|
|
6
|
+
source: "manual"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Context
|
|
10
|
+
These conventions apply to all work on the Squad CLI tool (`create-squad`). Squad is a zero-dependency Node.js package that adds AI agent teams to any project. Understanding these patterns is essential before modifying any Squad source code.
|
|
11
|
+
|
|
12
|
+
## Patterns
|
|
13
|
+
|
|
14
|
+
### Zero Dependencies
|
|
15
|
+
Squad has zero runtime dependencies. Everything uses Node.js built-ins (`fs`, `path`, `os`, `child_process`). Do not add packages to `dependencies` in `package.json`. This is a hard constraint, not a preference.
|
|
16
|
+
|
|
17
|
+
### Node.js Built-in Test Runner
|
|
18
|
+
Tests use `node:test` and `node:assert/strict` — no test frameworks. Run with `npm test`. Test files live in `test/`. The test command is `node --test test/`.
|
|
19
|
+
|
|
20
|
+
### Error Handling — `fatal()` Pattern
|
|
21
|
+
All user-facing errors use the `fatal(msg)` function which prints a red `✗` prefix and exits with code 1. Never throw unhandled exceptions or print raw stack traces. The global `uncaughtException` handler calls `fatal()` as a safety net.
|
|
22
|
+
|
|
23
|
+
### ANSI Color Constants
|
|
24
|
+
Colors are defined as constants at the top of `index.js`: `GREEN`, `RED`, `DIM`, `BOLD`, `RESET`. Use these constants — do not inline ANSI escape codes.
|
|
25
|
+
|
|
26
|
+
### File Structure
|
|
27
|
+
- `.squad/` — Team state (user-owned, never overwritten by upgrades)
|
|
28
|
+
- `.squad/templates/` — Template files copied from `templates/` (Squad-owned, overwritten on upgrade)
|
|
29
|
+
- `.github/agents/squad.agent.md` — Coordinator prompt (Squad-owned, overwritten on upgrade)
|
|
30
|
+
- `templates/` — Source templates shipped with the npm package
|
|
31
|
+
- `.squad/skills/` — Team skills in SKILL.md format (user-owned)
|
|
32
|
+
- `.squad/decisions/inbox/` — Drop-box for parallel decision writes
|
|
33
|
+
|
|
34
|
+
### Windows Compatibility
|
|
35
|
+
Always use `path.join()` for file paths — never hardcode `/` or `\` separators. Squad must work on Windows, macOS, and Linux. All tests must pass on all platforms.
|
|
36
|
+
|
|
37
|
+
### Init Idempotency
|
|
38
|
+
The init flow uses a skip-if-exists pattern: if a file or directory already exists, skip it and report "already exists." Never overwrite user state during init. The upgrade flow overwrites only Squad-owned files.
|
|
39
|
+
|
|
40
|
+
### Copy Pattern
|
|
41
|
+
`copyRecursive(src, target)` handles both files and directories. It creates parent directories with `{ recursive: true }` and uses `fs.copyFileSync` for files.
|
|
42
|
+
|
|
43
|
+
## Examples
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
// Error handling
|
|
47
|
+
function fatal(msg) {
|
|
48
|
+
console.error(`${RED}✗${RESET} ${msg}`);
|
|
49
|
+
process.exit(1);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// File path construction (Windows-safe)
|
|
53
|
+
const agentDest = path.join(dest, '.github', 'agents', 'squad.agent.md');
|
|
54
|
+
|
|
55
|
+
// Skip-if-exists pattern
|
|
56
|
+
if (!fs.existsSync(ceremoniesDest)) {
|
|
57
|
+
fs.copyFileSync(ceremoniesSrc, ceremoniesDest);
|
|
58
|
+
console.log(`${GREEN}✓${RESET} .squad/ceremonies.md`);
|
|
59
|
+
} else {
|
|
60
|
+
console.log(`${DIM}ceremonies.md already exists — skipping${RESET}`);
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Anti-Patterns
|
|
65
|
+
- **Adding npm dependencies** — Squad is zero-dep. Use Node.js built-ins only.
|
|
66
|
+
- **Hardcoded path separators** — Never use `/` or `\` directly. Always `path.join()`.
|
|
67
|
+
- **Overwriting user state on init** — Init skips existing files. Only upgrade overwrites Squad-owned files.
|
|
68
|
+
- **Raw stack traces** — All errors go through `fatal()`. Users see clean messages, not stack traces.
|
|
69
|
+
- **Inline ANSI codes** — Use the color constants (`GREEN`, `RED`, `DIM`, `BOLD`, `RESET`).
|