@bradygaster/squad-cli 0.8.20 → 0.8.22

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.
Files changed (104) hide show
  1. package/README.md +77 -77
  2. package/dist/cli/commands/build.d.ts +31 -0
  3. package/dist/cli/commands/build.d.ts.map +1 -0
  4. package/dist/cli/commands/build.js +453 -0
  5. package/dist/cli/commands/build.js.map +1 -0
  6. package/dist/cli/commands/init-remote.d.ts.map +1 -1
  7. package/dist/cli/commands/init-remote.js +13 -0
  8. package/dist/cli/commands/init-remote.js.map +1 -1
  9. package/dist/cli/commands/link.d.ts.map +1 -1
  10. package/dist/cli/commands/link.js +13 -0
  11. package/dist/cli/commands/link.js.map +1 -1
  12. package/dist/cli/commands/migrate.d.ts +14 -0
  13. package/dist/cli/commands/migrate.d.ts.map +1 -0
  14. package/dist/cli/commands/migrate.js +419 -0
  15. package/dist/cli/commands/migrate.js.map +1 -0
  16. package/dist/cli/commands/streams.d.ts +15 -0
  17. package/dist/cli/commands/streams.d.ts.map +1 -0
  18. package/dist/cli/commands/streams.js +147 -0
  19. package/dist/cli/commands/streams.js.map +1 -0
  20. package/dist/cli/core/cast.d.ts.map +1 -1
  21. package/dist/cli/core/cast.js +111 -63
  22. package/dist/cli/core/cast.js.map +1 -1
  23. package/dist/cli/core/init.d.ts +4 -0
  24. package/dist/cli/core/init.d.ts.map +1 -1
  25. package/dist/cli/core/init.js +2 -2
  26. package/dist/cli/core/init.js.map +1 -1
  27. package/dist/cli/core/team-md.js +34 -34
  28. package/dist/cli/core/templates.d.ts.map +1 -1
  29. package/dist/cli/core/templates.js +0 -6
  30. package/dist/cli/core/templates.js.map +1 -1
  31. package/dist/cli/core/upgrade.d.ts.map +1 -1
  32. package/dist/cli/core/upgrade.js +2 -1
  33. package/dist/cli/core/upgrade.js.map +1 -1
  34. package/dist/cli/index.d.ts +1 -0
  35. package/dist/cli/index.d.ts.map +1 -1
  36. package/dist/cli/index.js +1 -0
  37. package/dist/cli/index.js.map +1 -1
  38. package/dist/cli/shell/commands.d.ts +6 -0
  39. package/dist/cli/shell/commands.d.ts.map +1 -1
  40. package/dist/cli/shell/commands.js +2 -1
  41. package/dist/cli/shell/commands.js.map +1 -1
  42. package/dist/cli/shell/components/AgentPanel.d.ts.map +1 -1
  43. package/dist/cli/shell/components/AgentPanel.js +4 -3
  44. package/dist/cli/shell/components/AgentPanel.js.map +1 -1
  45. package/dist/cli/shell/components/App.d.ts.map +1 -1
  46. package/dist/cli/shell/components/App.js +36 -2
  47. package/dist/cli/shell/components/App.js.map +1 -1
  48. package/dist/cli/shell/components/MessageStream.d.ts.map +1 -1
  49. package/dist/cli/shell/components/MessageStream.js +2 -1
  50. package/dist/cli/shell/components/MessageStream.js.map +1 -1
  51. package/dist/cli/shell/components/ThinkingIndicator.js +2 -2
  52. package/dist/cli/shell/components/ThinkingIndicator.js.map +1 -1
  53. package/dist/cli/shell/coordinator.js +88 -88
  54. package/dist/cli/shell/index.d.ts.map +1 -1
  55. package/dist/cli/shell/index.js +41 -3
  56. package/dist/cli/shell/index.js.map +1 -1
  57. package/dist/cli-entry.js +206 -14
  58. package/dist/cli-entry.js.map +1 -1
  59. package/package.json +27 -2
  60. package/templates/casting-history.json +4 -4
  61. package/templates/casting-policy.json +35 -35
  62. package/templates/casting-registry.json +3 -3
  63. package/templates/ceremonies.md +41 -41
  64. package/templates/charter.md +53 -53
  65. package/templates/constraint-tracking.md +38 -38
  66. package/templates/copilot-instructions.md +46 -46
  67. package/templates/history.md +10 -10
  68. package/templates/identity/now.md +9 -9
  69. package/templates/identity/wisdom.md +15 -15
  70. package/templates/mcp-config.md +90 -90
  71. package/templates/multi-agent-format.md +28 -28
  72. package/templates/orchestration-log.md +27 -27
  73. package/templates/plugin-marketplace.md +49 -49
  74. package/templates/raw-agent-output.md +37 -37
  75. package/templates/roster.md +60 -60
  76. package/templates/routing.md +54 -54
  77. package/templates/run-output.md +50 -50
  78. package/templates/scribe-charter.md +119 -119
  79. package/templates/skill.md +24 -24
  80. package/templates/skills/squad-conventions/SKILL.md +69 -69
  81. package/templates/squad.agent.md +1146 -1146
  82. package/templates/workflows/squad-ci.yml +24 -24
  83. package/templates/workflows/squad-docs.yml +50 -50
  84. package/templates/workflows/squad-insider-release.yml +61 -61
  85. package/templates/workflows/squad-issue-assign.yml +161 -161
  86. package/templates/workflows/squad-label-enforce.yml +181 -181
  87. package/templates/workflows/squad-preview.yml +55 -55
  88. package/templates/workflows/squad-promote.yml +120 -120
  89. package/templates/workflows/squad-release.yml +77 -77
  90. package/templates/workflows/squad-triage.yml +260 -260
  91. package/templates/workflows/sync-squad-labels.yml +169 -169
  92. package/dist/cli/shell/sdk-bridge.d.ts +0 -50
  93. package/dist/cli/shell/sdk-bridge.d.ts.map +0 -1
  94. package/dist/cli/shell/sdk-bridge.js +0 -235
  95. package/dist/cli/shell/sdk-bridge.js.map +0 -1
  96. package/dist/cli/shell/theme-colors.d.ts +0 -39
  97. package/dist/cli/shell/theme-colors.d.ts.map +0 -1
  98. package/dist/cli/shell/theme-colors.js +0 -39
  99. package/dist/cli/shell/theme-colors.js.map +0 -1
  100. package/dist/cli.d.ts +0 -3
  101. package/dist/cli.d.ts.map +0 -1
  102. package/dist/cli.js +0 -4
  103. package/dist/cli.js.map +0 -1
  104. package/templates/workflows/squad-main-guard.yml +0 -129
@@ -1,119 +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` (use filename-safe timestamps — replace colons with hyphens, e.g., `2026-02-23T20-16-27Z` not `2026-02-23T20:16:27Z`, for Windows compatibility):
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.
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` (use filename-safe timestamps — replace colons with hyphens, e.g., `2026-02-23T20-16-27Z` not `2026-02-23T20:16:27Z`, for Windows compatibility):
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.
@@ -1,24 +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}
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}
@@ -1,69 +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`).
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`).