@orchestrator-claude/definitions 3.30.2 → 3.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/agents/adversarial-reviewer.md +217 -0
  2. package/agents/azure-devops-engineer.md +805 -0
  3. package/agents/methodology-researcher.md +190 -0
  4. package/agents/operational-artifact-builder.md +173 -0
  5. package/agents/presentation-engineer.md +605 -0
  6. package/dist/scripts/generate-manifest.js +3 -3
  7. package/dist/scripts/generate-manifest.js.map +1 -1
  8. package/hooks/mailbox-listener.ts +246 -0
  9. package/hooks/pre-agent-dispatch.ts +57 -0
  10. package/hooks/sprint-registry.ts +85 -0
  11. package/hooks/verification-before-completion.ts +97 -0
  12. package/manifest.json +276 -3
  13. package/package.json +1 -1
  14. package/skills/artifact-generator/SKILL.md +385 -0
  15. package/skills/brainstorm-formalize/SKILL.md +272 -0
  16. package/skills/brainstorming/SKILL.md +167 -0
  17. package/skills/brainstorming/scripts/frame-template.html +214 -0
  18. package/skills/brainstorming/scripts/helper.js +88 -0
  19. package/skills/brainstorming/scripts/server.cjs +354 -0
  20. package/skills/brainstorming/scripts/start-server.sh +148 -0
  21. package/skills/brainstorming/scripts/stop-server.sh +56 -0
  22. package/skills/brainstorming/visual-companion.md +139 -0
  23. package/skills/compositional-intelligence/SKILL.md +93 -0
  24. package/skills/design-system-validated-loop/SKILL.md +366 -0
  25. package/skills/finishing-branch/SKILL.md +184 -0
  26. package/skills/orchestrator/SKILL.md +141 -0
  27. package/skills/persona-library/SKILL.md +365 -0
  28. package/skills/project-management-enterprise/SKILL.md +304 -0
  29. package/skills/receiving-code-review/SKILL.md +186 -0
  30. package/skills/sprint-launch/SKILL.md +176 -0
  31. package/skills/sprint-teammate/sprint-teammate.md +107 -0
  32. package/skills/systematic-debugging/SKILL.md +262 -0
@@ -0,0 +1,354 @@
1
+ const crypto = require('crypto');
2
+ const http = require('http');
3
+ const fs = require('fs');
4
+ const path = require('path');
5
+
6
+ // ========== WebSocket Protocol (RFC 6455) ==========
7
+
8
+ const OPCODES = { TEXT: 0x01, CLOSE: 0x08, PING: 0x09, PONG: 0x0A };
9
+ const WS_MAGIC = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
10
+
11
+ function computeAcceptKey(clientKey) {
12
+ return crypto.createHash('sha1').update(clientKey + WS_MAGIC).digest('base64');
13
+ }
14
+
15
+ function encodeFrame(opcode, payload) {
16
+ const fin = 0x80;
17
+ const len = payload.length;
18
+ let header;
19
+
20
+ if (len < 126) {
21
+ header = Buffer.alloc(2);
22
+ header[0] = fin | opcode;
23
+ header[1] = len;
24
+ } else if (len < 65536) {
25
+ header = Buffer.alloc(4);
26
+ header[0] = fin | opcode;
27
+ header[1] = 126;
28
+ header.writeUInt16BE(len, 2);
29
+ } else {
30
+ header = Buffer.alloc(10);
31
+ header[0] = fin | opcode;
32
+ header[1] = 127;
33
+ header.writeBigUInt64BE(BigInt(len), 2);
34
+ }
35
+
36
+ return Buffer.concat([header, payload]);
37
+ }
38
+
39
+ function decodeFrame(buffer) {
40
+ if (buffer.length < 2) return null;
41
+
42
+ const secondByte = buffer[1];
43
+ const opcode = buffer[0] & 0x0F;
44
+ const masked = (secondByte & 0x80) !== 0;
45
+ let payloadLen = secondByte & 0x7F;
46
+ let offset = 2;
47
+
48
+ if (!masked) throw new Error('Client frames must be masked');
49
+
50
+ if (payloadLen === 126) {
51
+ if (buffer.length < 4) return null;
52
+ payloadLen = buffer.readUInt16BE(2);
53
+ offset = 4;
54
+ } else if (payloadLen === 127) {
55
+ if (buffer.length < 10) return null;
56
+ payloadLen = Number(buffer.readBigUInt64BE(2));
57
+ offset = 10;
58
+ }
59
+
60
+ const maskOffset = offset;
61
+ const dataOffset = offset + 4;
62
+ const totalLen = dataOffset + payloadLen;
63
+ if (buffer.length < totalLen) return null;
64
+
65
+ const mask = buffer.slice(maskOffset, dataOffset);
66
+ const data = Buffer.alloc(payloadLen);
67
+ for (let i = 0; i < payloadLen; i++) {
68
+ data[i] = buffer[dataOffset + i] ^ mask[i % 4];
69
+ }
70
+
71
+ return { opcode, payload: data, bytesConsumed: totalLen };
72
+ }
73
+
74
+ // ========== Configuration ==========
75
+
76
+ const PORT = process.env.BRAINSTORM_PORT || (49152 + Math.floor(Math.random() * 16383));
77
+ const HOST = process.env.BRAINSTORM_HOST || '127.0.0.1';
78
+ const URL_HOST = process.env.BRAINSTORM_URL_HOST || (HOST === '127.0.0.1' ? 'localhost' : HOST);
79
+ const SESSION_DIR = process.env.BRAINSTORM_DIR || '/tmp/brainstorm';
80
+ const CONTENT_DIR = path.join(SESSION_DIR, 'content');
81
+ const STATE_DIR = path.join(SESSION_DIR, 'state');
82
+ let ownerPid = process.env.BRAINSTORM_OWNER_PID ? Number(process.env.BRAINSTORM_OWNER_PID) : null;
83
+
84
+ const MIME_TYPES = {
85
+ '.html': 'text/html', '.css': 'text/css', '.js': 'application/javascript',
86
+ '.json': 'application/json', '.png': 'image/png', '.jpg': 'image/jpeg',
87
+ '.jpeg': 'image/jpeg', '.gif': 'image/gif', '.svg': 'image/svg+xml'
88
+ };
89
+
90
+ // ========== Templates and Constants ==========
91
+
92
+ const WAITING_PAGE = `<!DOCTYPE html>
93
+ <html>
94
+ <head><meta charset="utf-8"><title>Brainstorm Companion</title>
95
+ <style>body { font-family: system-ui, sans-serif; padding: 2rem; max-width: 800px; margin: 0 auto; }
96
+ h1 { color: #333; } p { color: #666; }</style>
97
+ </head>
98
+ <body><h1>Brainstorm Companion</h1>
99
+ <p>Waiting for the agent to push a screen...</p></body></html>`;
100
+
101
+ const frameTemplate = fs.readFileSync(path.join(__dirname, 'frame-template.html'), 'utf-8');
102
+ const helperScript = fs.readFileSync(path.join(__dirname, 'helper.js'), 'utf-8');
103
+ const helperInjection = '<script>\n' + helperScript + '\n</script>';
104
+
105
+ // ========== Helper Functions ==========
106
+
107
+ function isFullDocument(html) {
108
+ const trimmed = html.trimStart().toLowerCase();
109
+ return trimmed.startsWith('<!doctype') || trimmed.startsWith('<html');
110
+ }
111
+
112
+ function wrapInFrame(content) {
113
+ return frameTemplate.replace('<!-- CONTENT -->', content);
114
+ }
115
+
116
+ function getNewestScreen() {
117
+ const files = fs.readdirSync(CONTENT_DIR)
118
+ .filter(f => f.endsWith('.html'))
119
+ .map(f => {
120
+ const fp = path.join(CONTENT_DIR, f);
121
+ return { path: fp, mtime: fs.statSync(fp).mtime.getTime() };
122
+ })
123
+ .sort((a, b) => b.mtime - a.mtime);
124
+ return files.length > 0 ? files[0].path : null;
125
+ }
126
+
127
+ // ========== HTTP Request Handler ==========
128
+
129
+ function handleRequest(req, res) {
130
+ touchActivity();
131
+ if (req.method === 'GET' && req.url === '/') {
132
+ const screenFile = getNewestScreen();
133
+ let html = screenFile
134
+ ? (raw => isFullDocument(raw) ? raw : wrapInFrame(raw))(fs.readFileSync(screenFile, 'utf-8'))
135
+ : WAITING_PAGE;
136
+
137
+ if (html.includes('</body>')) {
138
+ html = html.replace('</body>', helperInjection + '\n</body>');
139
+ } else {
140
+ html += helperInjection;
141
+ }
142
+
143
+ res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
144
+ res.end(html);
145
+ } else if (req.method === 'GET' && req.url.startsWith('/files/')) {
146
+ const fileName = req.url.slice(7);
147
+ const filePath = path.join(CONTENT_DIR, path.basename(fileName));
148
+ if (!fs.existsSync(filePath)) {
149
+ res.writeHead(404);
150
+ res.end('Not found');
151
+ return;
152
+ }
153
+ const ext = path.extname(filePath).toLowerCase();
154
+ const contentType = MIME_TYPES[ext] || 'application/octet-stream';
155
+ res.writeHead(200, { 'Content-Type': contentType });
156
+ res.end(fs.readFileSync(filePath));
157
+ } else {
158
+ res.writeHead(404);
159
+ res.end('Not found');
160
+ }
161
+ }
162
+
163
+ // ========== WebSocket Connection Handling ==========
164
+
165
+ const clients = new Set();
166
+
167
+ function handleUpgrade(req, socket) {
168
+ const key = req.headers['sec-websocket-key'];
169
+ if (!key) { socket.destroy(); return; }
170
+
171
+ const accept = computeAcceptKey(key);
172
+ socket.write(
173
+ 'HTTP/1.1 101 Switching Protocols\r\n' +
174
+ 'Upgrade: websocket\r\n' +
175
+ 'Connection: Upgrade\r\n' +
176
+ 'Sec-WebSocket-Accept: ' + accept + '\r\n\r\n'
177
+ );
178
+
179
+ let buffer = Buffer.alloc(0);
180
+ clients.add(socket);
181
+
182
+ socket.on('data', (chunk) => {
183
+ buffer = Buffer.concat([buffer, chunk]);
184
+ while (buffer.length > 0) {
185
+ let result;
186
+ try {
187
+ result = decodeFrame(buffer);
188
+ } catch (e) {
189
+ socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
190
+ clients.delete(socket);
191
+ return;
192
+ }
193
+ if (!result) break;
194
+ buffer = buffer.slice(result.bytesConsumed);
195
+
196
+ switch (result.opcode) {
197
+ case OPCODES.TEXT:
198
+ handleMessage(result.payload.toString());
199
+ break;
200
+ case OPCODES.CLOSE:
201
+ socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
202
+ clients.delete(socket);
203
+ return;
204
+ case OPCODES.PING:
205
+ socket.write(encodeFrame(OPCODES.PONG, result.payload));
206
+ break;
207
+ case OPCODES.PONG:
208
+ break;
209
+ default: {
210
+ const closeBuf = Buffer.alloc(2);
211
+ closeBuf.writeUInt16BE(1003);
212
+ socket.end(encodeFrame(OPCODES.CLOSE, closeBuf));
213
+ clients.delete(socket);
214
+ return;
215
+ }
216
+ }
217
+ }
218
+ });
219
+
220
+ socket.on('close', () => clients.delete(socket));
221
+ socket.on('error', () => clients.delete(socket));
222
+ }
223
+
224
+ function handleMessage(text) {
225
+ let event;
226
+ try {
227
+ event = JSON.parse(text);
228
+ } catch (e) {
229
+ console.error('Failed to parse WebSocket message:', e.message);
230
+ return;
231
+ }
232
+ touchActivity();
233
+ console.log(JSON.stringify({ source: 'user-event', ...event }));
234
+ if (event.choice) {
235
+ const eventsFile = path.join(STATE_DIR, 'events');
236
+ fs.appendFileSync(eventsFile, JSON.stringify(event) + '\n');
237
+ }
238
+ }
239
+
240
+ function broadcast(msg) {
241
+ const frame = encodeFrame(OPCODES.TEXT, Buffer.from(JSON.stringify(msg)));
242
+ for (const socket of clients) {
243
+ try { socket.write(frame); } catch (e) { clients.delete(socket); }
244
+ }
245
+ }
246
+
247
+ // ========== Activity Tracking ==========
248
+
249
+ const IDLE_TIMEOUT_MS = 30 * 60 * 1000; // 30 minutes
250
+ let lastActivity = Date.now();
251
+
252
+ function touchActivity() {
253
+ lastActivity = Date.now();
254
+ }
255
+
256
+ // ========== File Watching ==========
257
+
258
+ const debounceTimers = new Map();
259
+
260
+ // ========== Server Startup ==========
261
+
262
+ function startServer() {
263
+ if (!fs.existsSync(CONTENT_DIR)) fs.mkdirSync(CONTENT_DIR, { recursive: true });
264
+ if (!fs.existsSync(STATE_DIR)) fs.mkdirSync(STATE_DIR, { recursive: true });
265
+
266
+ // Track known files to distinguish new screens from updates.
267
+ // macOS fs.watch reports 'rename' for both new files and overwrites,
268
+ // so we can't rely on eventType alone.
269
+ const knownFiles = new Set(
270
+ fs.readdirSync(CONTENT_DIR).filter(f => f.endsWith('.html'))
271
+ );
272
+
273
+ const server = http.createServer(handleRequest);
274
+ server.on('upgrade', handleUpgrade);
275
+
276
+ const watcher = fs.watch(CONTENT_DIR, (eventType, filename) => {
277
+ if (!filename || !filename.endsWith('.html')) return;
278
+
279
+ if (debounceTimers.has(filename)) clearTimeout(debounceTimers.get(filename));
280
+ debounceTimers.set(filename, setTimeout(() => {
281
+ debounceTimers.delete(filename);
282
+ const filePath = path.join(CONTENT_DIR, filename);
283
+
284
+ if (!fs.existsSync(filePath)) return; // file was deleted
285
+ touchActivity();
286
+
287
+ if (!knownFiles.has(filename)) {
288
+ knownFiles.add(filename);
289
+ const eventsFile = path.join(STATE_DIR, 'events');
290
+ if (fs.existsSync(eventsFile)) fs.unlinkSync(eventsFile);
291
+ console.log(JSON.stringify({ type: 'screen-added', file: filePath }));
292
+ } else {
293
+ console.log(JSON.stringify({ type: 'screen-updated', file: filePath }));
294
+ }
295
+
296
+ broadcast({ type: 'reload' });
297
+ }, 100));
298
+ });
299
+ watcher.on('error', (err) => console.error('fs.watch error:', err.message));
300
+
301
+ function shutdown(reason) {
302
+ console.log(JSON.stringify({ type: 'server-stopped', reason }));
303
+ const infoFile = path.join(STATE_DIR, 'server-info');
304
+ if (fs.existsSync(infoFile)) fs.unlinkSync(infoFile);
305
+ fs.writeFileSync(
306
+ path.join(STATE_DIR, 'server-stopped'),
307
+ JSON.stringify({ reason, timestamp: Date.now() }) + '\n'
308
+ );
309
+ watcher.close();
310
+ clearInterval(lifecycleCheck);
311
+ server.close(() => process.exit(0));
312
+ }
313
+
314
+ function ownerAlive() {
315
+ if (!ownerPid) return true;
316
+ try { process.kill(ownerPid, 0); return true; } catch (e) { return e.code === 'EPERM'; }
317
+ }
318
+
319
+ // Check every 60s: exit if owner process died or idle for 30 minutes
320
+ const lifecycleCheck = setInterval(() => {
321
+ if (!ownerAlive()) shutdown('owner process exited');
322
+ else if (Date.now() - lastActivity > IDLE_TIMEOUT_MS) shutdown('idle timeout');
323
+ }, 60 * 1000);
324
+ lifecycleCheck.unref();
325
+
326
+ // Validate owner PID at startup. If it's already dead, the PID resolution
327
+ // was wrong (common on WSL, Tailscale SSH, and cross-user scenarios).
328
+ // Disable monitoring and rely on the idle timeout instead.
329
+ if (ownerPid) {
330
+ try { process.kill(ownerPid, 0); }
331
+ catch (e) {
332
+ if (e.code !== 'EPERM') {
333
+ console.log(JSON.stringify({ type: 'owner-pid-invalid', pid: ownerPid, reason: 'dead at startup' }));
334
+ ownerPid = null;
335
+ }
336
+ }
337
+ }
338
+
339
+ server.listen(PORT, HOST, () => {
340
+ const info = JSON.stringify({
341
+ type: 'server-started', port: Number(PORT), host: HOST,
342
+ url_host: URL_HOST, url: 'http://' + URL_HOST + ':' + PORT,
343
+ screen_dir: CONTENT_DIR, state_dir: STATE_DIR
344
+ });
345
+ console.log(info);
346
+ fs.writeFileSync(path.join(STATE_DIR, 'server-info'), info + '\n');
347
+ });
348
+ }
349
+
350
+ if (require.main === module) {
351
+ startServer();
352
+ }
353
+
354
+ module.exports = { computeAcceptKey, encodeFrame, decodeFrame, OPCODES };
@@ -0,0 +1,148 @@
1
+ #!/usr/bin/env bash
2
+ # Start the brainstorm server and output connection info
3
+ # Usage: start-server.sh [--project-dir <path>] [--host <bind-host>] [--url-host <display-host>] [--foreground] [--background]
4
+ #
5
+ # Starts server on a random high port, outputs JSON with URL.
6
+ # Each session gets its own directory to avoid conflicts.
7
+ #
8
+ # Options:
9
+ # --project-dir <path> Store session files under <path>/.superpowers/brainstorm/
10
+ # instead of /tmp. Files persist after server stops.
11
+ # --host <bind-host> Host/interface to bind (default: 127.0.0.1).
12
+ # Use 0.0.0.0 in remote/containerized environments.
13
+ # --url-host <host> Hostname shown in returned URL JSON.
14
+ # --foreground Run server in the current terminal (no backgrounding).
15
+ # --background Force background mode (overrides Codex auto-foreground).
16
+
17
+ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
18
+
19
+ # Parse arguments
20
+ PROJECT_DIR=""
21
+ FOREGROUND="false"
22
+ FORCE_BACKGROUND="false"
23
+ BIND_HOST="127.0.0.1"
24
+ URL_HOST=""
25
+ while [[ $# -gt 0 ]]; do
26
+ case "$1" in
27
+ --project-dir)
28
+ PROJECT_DIR="$2"
29
+ shift 2
30
+ ;;
31
+ --host)
32
+ BIND_HOST="$2"
33
+ shift 2
34
+ ;;
35
+ --url-host)
36
+ URL_HOST="$2"
37
+ shift 2
38
+ ;;
39
+ --foreground|--no-daemon)
40
+ FOREGROUND="true"
41
+ shift
42
+ ;;
43
+ --background|--daemon)
44
+ FORCE_BACKGROUND="true"
45
+ shift
46
+ ;;
47
+ *)
48
+ echo "{\"error\": \"Unknown argument: $1\"}"
49
+ exit 1
50
+ ;;
51
+ esac
52
+ done
53
+
54
+ if [[ -z "$URL_HOST" ]]; then
55
+ if [[ "$BIND_HOST" == "127.0.0.1" || "$BIND_HOST" == "localhost" ]]; then
56
+ URL_HOST="localhost"
57
+ else
58
+ URL_HOST="$BIND_HOST"
59
+ fi
60
+ fi
61
+
62
+ # Some environments reap detached/background processes. Auto-foreground when detected.
63
+ if [[ -n "${CODEX_CI:-}" && "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
64
+ FOREGROUND="true"
65
+ fi
66
+
67
+ # Windows/Git Bash reaps nohup background processes. Auto-foreground when detected.
68
+ if [[ "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
69
+ case "${OSTYPE:-}" in
70
+ msys*|cygwin*|mingw*) FOREGROUND="true" ;;
71
+ esac
72
+ if [[ -n "${MSYSTEM:-}" ]]; then
73
+ FOREGROUND="true"
74
+ fi
75
+ fi
76
+
77
+ # Generate unique session directory
78
+ SESSION_ID="$$-$(date +%s)"
79
+
80
+ if [[ -n "$PROJECT_DIR" ]]; then
81
+ SESSION_DIR="${PROJECT_DIR}/.superpowers/brainstorm/${SESSION_ID}"
82
+ else
83
+ SESSION_DIR="/tmp/brainstorm-${SESSION_ID}"
84
+ fi
85
+
86
+ STATE_DIR="${SESSION_DIR}/state"
87
+ PID_FILE="${STATE_DIR}/server.pid"
88
+ LOG_FILE="${STATE_DIR}/server.log"
89
+
90
+ # Create fresh session directory with content and state peers
91
+ mkdir -p "${SESSION_DIR}/content" "$STATE_DIR"
92
+
93
+ # Kill any existing server
94
+ if [[ -f "$PID_FILE" ]]; then
95
+ old_pid=$(cat "$PID_FILE")
96
+ kill "$old_pid" 2>/dev/null
97
+ rm -f "$PID_FILE"
98
+ fi
99
+
100
+ cd "$SCRIPT_DIR"
101
+
102
+ # Resolve the harness PID (grandparent of this script).
103
+ # $PPID is the ephemeral shell the harness spawned to run us — it dies
104
+ # when this script exits. The harness itself is $PPID's parent.
105
+ OWNER_PID="$(ps -o ppid= -p "$PPID" 2>/dev/null | tr -d ' ')"
106
+ if [[ -z "$OWNER_PID" || "$OWNER_PID" == "1" ]]; then
107
+ OWNER_PID="$PPID"
108
+ fi
109
+
110
+ # Foreground mode for environments that reap detached/background processes.
111
+ if [[ "$FOREGROUND" == "true" ]]; then
112
+ echo "$$" > "$PID_FILE"
113
+ env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs
114
+ exit $?
115
+ fi
116
+
117
+ # Start server, capturing output to log file
118
+ # Use nohup to survive shell exit; disown to remove from job table
119
+ nohup env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs > "$LOG_FILE" 2>&1 &
120
+ SERVER_PID=$!
121
+ disown "$SERVER_PID" 2>/dev/null
122
+ echo "$SERVER_PID" > "$PID_FILE"
123
+
124
+ # Wait for server-started message (check log file)
125
+ for i in {1..50}; do
126
+ if grep -q "server-started" "$LOG_FILE" 2>/dev/null; then
127
+ # Verify server is still alive after a short window (catches process reapers)
128
+ alive="true"
129
+ for _ in {1..20}; do
130
+ if ! kill -0 "$SERVER_PID" 2>/dev/null; then
131
+ alive="false"
132
+ break
133
+ fi
134
+ sleep 0.1
135
+ done
136
+ if [[ "$alive" != "true" ]]; then
137
+ echo "{\"error\": \"Server started but was killed. Retry in a persistent terminal with: $SCRIPT_DIR/start-server.sh${PROJECT_DIR:+ --project-dir $PROJECT_DIR} --host $BIND_HOST --url-host $URL_HOST --foreground\"}"
138
+ exit 1
139
+ fi
140
+ grep "server-started" "$LOG_FILE" | head -1
141
+ exit 0
142
+ fi
143
+ sleep 0.1
144
+ done
145
+
146
+ # Timeout - server didn't start
147
+ echo '{"error": "Server failed to start within 5 seconds"}'
148
+ exit 1
@@ -0,0 +1,56 @@
1
+ #!/usr/bin/env bash
2
+ # Stop the brainstorm server and clean up
3
+ # Usage: stop-server.sh <session_dir>
4
+ #
5
+ # Kills the server process. Only deletes session directory if it's
6
+ # under /tmp (ephemeral). Persistent directories (.superpowers/) are
7
+ # kept so mockups can be reviewed later.
8
+
9
+ SESSION_DIR="$1"
10
+
11
+ if [[ -z "$SESSION_DIR" ]]; then
12
+ echo '{"error": "Usage: stop-server.sh <session_dir>"}'
13
+ exit 1
14
+ fi
15
+
16
+ STATE_DIR="${SESSION_DIR}/state"
17
+ PID_FILE="${STATE_DIR}/server.pid"
18
+
19
+ if [[ -f "$PID_FILE" ]]; then
20
+ pid=$(cat "$PID_FILE")
21
+
22
+ # Try to stop gracefully, fallback to force if still alive
23
+ kill "$pid" 2>/dev/null || true
24
+
25
+ # Wait for graceful shutdown (up to ~2s)
26
+ for i in {1..20}; do
27
+ if ! kill -0 "$pid" 2>/dev/null; then
28
+ break
29
+ fi
30
+ sleep 0.1
31
+ done
32
+
33
+ # If still running, escalate to SIGKILL
34
+ if kill -0 "$pid" 2>/dev/null; then
35
+ kill -9 "$pid" 2>/dev/null || true
36
+
37
+ # Give SIGKILL a moment to take effect
38
+ sleep 0.1
39
+ fi
40
+
41
+ if kill -0 "$pid" 2>/dev/null; then
42
+ echo '{"status": "failed", "error": "process still running"}'
43
+ exit 1
44
+ fi
45
+
46
+ rm -f "$PID_FILE" "${STATE_DIR}/server.log"
47
+
48
+ # Only delete ephemeral /tmp directories
49
+ if [[ "$SESSION_DIR" == /tmp/* ]]; then
50
+ rm -rf "$SESSION_DIR"
51
+ fi
52
+
53
+ echo '{"status": "stopped"}'
54
+ else
55
+ echo '{"status": "not_running"}'
56
+ fi
@@ -0,0 +1,139 @@
1
+ # Visual Companion Guide
2
+
3
+ Browser-based visual brainstorming companion for showing mockups, diagrams, and options.
4
+
5
+ ## When to Use
6
+
7
+ Decide per-question, not per-session. The test: **would the user understand this better by seeing it than reading it?**
8
+
9
+ **Use the browser** when the content itself is visual:
10
+
11
+ - **UI mockups** — wireframes, layouts, navigation structures, component designs
12
+ - **Architecture diagrams** — system components, data flow, relationship maps
13
+ - **Side-by-side visual comparisons** — comparing two layouts, two color schemes, two design directions
14
+ - **Design polish** — when the question is about look and feel, spacing, visual hierarchy
15
+ - **Spatial relationships** — state machines, flowcharts, entity relationships rendered as diagrams
16
+
17
+ **Use the terminal** when the content is text or tabular:
18
+
19
+ - **Requirements and scope questions** — "what does X mean?", "which features are in scope?"
20
+ - **Conceptual A/B/C choices** — picking between approaches described in words
21
+ - **Tradeoff lists** — pros/cons, comparison tables
22
+ - **Technical decisions** — API design, data modeling, architectural approach selection
23
+ - **Clarifying questions** — anything where the answer is words, not a visual preference
24
+
25
+ A question *about* a UI topic is not automatically a visual question. "What kind of wizard do you want?" is conceptual — use the terminal. "Which of these wizard layouts feels right?" is visual — use the browser.
26
+
27
+ ## How It Works
28
+
29
+ The server watches a directory for HTML files and serves the newest one to the browser. You write HTML content to `screen_dir`, the user sees it in their browser and can click to select options. Selections are recorded to `state_dir/events` that you read on your next turn.
30
+
31
+ **Content fragments vs full documents:** If your HTML file starts with `<!DOCTYPE` or `<html`, the server serves it as-is (just injects the helper script). Otherwise, the server automatically wraps your content in the frame template — adding the header, CSS theme, selection indicator, and all interactive infrastructure. **Write content fragments by default.** Only write full documents when you need complete control over the page.
32
+
33
+ ## Starting a Session
34
+
35
+ ```bash
36
+ # Start server with persistence (mockups saved to project)
37
+ scripts/start-server.sh --project-dir /path/to/project
38
+
39
+ # Returns: {"type":"server-started","port":52341,"url":"http://localhost:52341",
40
+ # "screen_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/content",
41
+ # "state_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/state"}
42
+ ```
43
+
44
+ Save `screen_dir` and `state_dir` from the response. Tell user to open the URL.
45
+
46
+ **Finding connection info:** The server writes its startup JSON to `$STATE_DIR/server-info`. If you launched the server in the background and didn't capture stdout, read that file to get the URL and port. When using `--project-dir`, check `<project>/.superpowers/brainstorm/` for the session directory.
47
+
48
+ **Note:** Pass the project root as `--project-dir` so mockups persist in `.superpowers/brainstorm/` and survive server restarts. Without it, files go to `/tmp` and get cleaned up. Remind the user to add `.superpowers/` to `.gitignore` if it's not already there.
49
+
50
+ **Launching the server by platform:**
51
+
52
+ **Claude Code (macOS / Linux):**
53
+ ```bash
54
+ scripts/start-server.sh --project-dir /path/to/project
55
+ ```
56
+
57
+ **Claude Code (Windows):**
58
+ ```bash
59
+ # Use run_in_background: true on the Bash tool call so the server survives across conversation turns.
60
+ scripts/start-server.sh --project-dir /path/to/project
61
+ ```
62
+ When calling this via the Bash tool, set `run_in_background: true`. Then read `$STATE_DIR/server-info` on the next turn to get the URL and port.
63
+
64
+ ## The Loop
65
+
66
+ 1. **Check server is alive**, then **write HTML** to a new file in `screen_dir`:
67
+ - Before each write, check that `$STATE_DIR/server-info` exists. If it doesn't (or `$STATE_DIR/server-stopped` exists), the server has shut down — restart it with `start-server.sh` before continuing. The server auto-exits after 30 minutes of inactivity.
68
+ - Use semantic filenames: `platform.html`, `visual-style.html`, `layout.html`
69
+ - **Never reuse filenames** — each screen gets a fresh file
70
+ - Use Write tool — **never use cat/heredoc**
71
+ - Server automatically serves the newest file
72
+
73
+ 2. **Tell user what to expect and end your turn:**
74
+ - Remind them of the URL (every step, not just first)
75
+ - Give a brief text summary of what's on screen
76
+ - Ask them to respond in the terminal: "Take a look and let me know what you think. Click to select an option if you'd like."
77
+
78
+ 3. **On your next turn** — after the user responds in the terminal:
79
+ - Read `$STATE_DIR/events` if it exists — this contains the user's browser interactions as JSON lines
80
+ - Merge with the user's terminal text to get the full picture
81
+
82
+ 4. **Iterate or advance** — if feedback changes current screen, write a new file. Only move to the next question when the current step is validated.
83
+
84
+ 5. **Unload when returning to terminal** — push a waiting screen to clear the stale content:
85
+ ```html
86
+ <div style="display:flex;align-items:center;justify-content:center;min-height:60vh">
87
+ <p class="subtitle">Continuing in terminal...</p>
88
+ </div>
89
+ ```
90
+
91
+ 6. Repeat until done.
92
+
93
+ ## CSS Classes Available
94
+
95
+ ### Options (A/B/C choices)
96
+ ```html
97
+ <div class="options">
98
+ <div class="option" data-choice="a" onclick="toggleSelect(this)">
99
+ <div class="letter">A</div>
100
+ <div class="content"><h3>Title</h3><p>Description</p></div>
101
+ </div>
102
+ </div>
103
+ ```
104
+
105
+ ### Cards, Mockups, Split view
106
+ ```html
107
+ <div class="cards">
108
+ <div class="card" data-choice="design1" onclick="toggleSelect(this)">
109
+ <div class="card-image"><!-- mockup content --></div>
110
+ <div class="card-body"><h3>Name</h3><p>Description</p></div>
111
+ </div>
112
+ </div>
113
+
114
+ <div class="mockup">
115
+ <div class="mockup-header">Preview</div>
116
+ <div class="mockup-body"><!-- your mockup HTML --></div>
117
+ </div>
118
+
119
+ <div class="split">
120
+ <div class="mockup"><!-- left --></div>
121
+ <div class="mockup"><!-- right --></div>
122
+ </div>
123
+ ```
124
+
125
+ ## Browser Events Format
126
+
127
+ ```jsonl
128
+ {"type":"click","choice":"a","text":"Option A","timestamp":1706000101}
129
+ ```
130
+
131
+ The last `choice` event is typically the final selection.
132
+
133
+ ## Design Tips
134
+
135
+ - Scale fidelity to the question — wireframes for layout, polish for polish questions
136
+ - Explain the question on each page
137
+ - Iterate before advancing
138
+ - 2-4 options max per screen
139
+ - Use real content when it matters