claude-agent-skills 1.3.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.
- package/README.md +65 -0
- package/bundled-skills/ask-matt/SKILL.md +61 -0
- package/bundled-skills/brainstorming/SKILL.md +159 -0
- package/bundled-skills/brainstorming/scripts/frame-template.html +213 -0
- package/bundled-skills/brainstorming/scripts/helper.js +167 -0
- package/bundled-skills/brainstorming/scripts/server.cjs +723 -0
- package/bundled-skills/brainstorming/scripts/start-server.sh +209 -0
- package/bundled-skills/brainstorming/scripts/stop-server.sh +120 -0
- package/bundled-skills/brainstorming/spec-document-reviewer-prompt.md +49 -0
- package/bundled-skills/brainstorming/visual-companion.md +298 -0
- package/bundled-skills/cavecrew/README.md +41 -0
- package/bundled-skills/cavecrew/SKILL.md +82 -0
- package/bundled-skills/caveman/README.md +48 -0
- package/bundled-skills/caveman/SKILL.md +78 -0
- package/bundled-skills/caveman-commit/README.md +44 -0
- package/bundled-skills/caveman-commit/SKILL.md +65 -0
- package/bundled-skills/caveman-compress/README.md +163 -0
- package/bundled-skills/caveman-compress/SECURITY.md +31 -0
- package/bundled-skills/caveman-compress/SKILL.md +111 -0
- package/bundled-skills/caveman-compress/scripts/__init__.py +9 -0
- package/bundled-skills/caveman-compress/scripts/__main__.py +3 -0
- package/bundled-skills/caveman-compress/scripts/benchmark.py +80 -0
- package/bundled-skills/caveman-compress/scripts/cli.py +85 -0
- package/bundled-skills/caveman-compress/scripts/compress.py +342 -0
- package/bundled-skills/caveman-compress/scripts/detect.py +121 -0
- package/bundled-skills/caveman-compress/scripts/validate.py +213 -0
- package/bundled-skills/caveman-help/README.md +38 -0
- package/bundled-skills/caveman-help/SKILL.md +63 -0
- package/bundled-skills/caveman-review/README.md +33 -0
- package/bundled-skills/caveman-review/SKILL.md +55 -0
- package/bundled-skills/caveman-stats/README.md +30 -0
- package/bundled-skills/caveman-stats/SKILL.md +10 -0
- package/bundled-skills/codebase-design/DEEPENING.md +37 -0
- package/bundled-skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
- package/bundled-skills/codebase-design/SKILL.md +114 -0
- package/bundled-skills/council/SKILL.md +77 -0
- package/bundled-skills/diagnosing-bugs/SKILL.md +134 -0
- package/bundled-skills/diagnosing-bugs/scripts/hitl-loop.template.sh +41 -0
- package/bundled-skills/dispatching-parallel-agents/SKILL.md +185 -0
- package/bundled-skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/bundled-skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/bundled-skills/domain-modeling/SKILL.md +74 -0
- package/bundled-skills/edit-article/SKILL.md +15 -0
- package/bundled-skills/executing-plans/SKILL.md +70 -0
- package/bundled-skills/finishing-a-development-branch/SKILL.md +241 -0
- package/bundled-skills/git-guardrails-claude-code/SKILL.md +95 -0
- package/bundled-skills/git-guardrails-claude-code/scripts/block-dangerous-git.sh +25 -0
- package/bundled-skills/grill-me/SKILL.md +7 -0
- package/bundled-skills/grill-with-docs/SKILL.md +7 -0
- package/bundled-skills/grilling/SKILL.md +10 -0
- package/bundled-skills/handoff/SKILL.md +16 -0
- package/bundled-skills/i-am-dumb/SKILL.md +57 -0
- package/bundled-skills/implement/SKILL.md +15 -0
- package/bundled-skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/bundled-skills/improve-codebase-architecture/SKILL.md +66 -0
- package/bundled-skills/migrate-to-shoehorn/SKILL.md +118 -0
- package/bundled-skills/obsidian-vault/SKILL.md +59 -0
- package/bundled-skills/ponytail/SKILL.md +117 -0
- package/bundled-skills/ponytail-audit/SKILL.md +50 -0
- package/bundled-skills/ponytail-debt/SKILL.md +59 -0
- package/bundled-skills/ponytail-gain/SKILL.md +51 -0
- package/bundled-skills/ponytail-help/SKILL.md +43 -0
- package/bundled-skills/ponytail-review/SKILL.md +51 -0
- package/bundled-skills/prototype/LOGIC.md +79 -0
- package/bundled-skills/prototype/SKILL.md +31 -0
- package/bundled-skills/prototype/UI.md +112 -0
- package/bundled-skills/receiving-code-review/SKILL.md +213 -0
- package/bundled-skills/requesting-code-review/SKILL.md +103 -0
- package/bundled-skills/requesting-code-review/code-reviewer.md +172 -0
- package/bundled-skills/resolving-merge-conflicts/SKILL.md +14 -0
- package/bundled-skills/scaffold-exercises/SKILL.md +106 -0
- package/bundled-skills/setup-matt-pocock-skills/SKILL.md +127 -0
- package/bundled-skills/setup-matt-pocock-skills/domain.md +51 -0
- package/bundled-skills/setup-matt-pocock-skills/issue-tracker-github.md +34 -0
- package/bundled-skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +35 -0
- package/bundled-skills/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
- package/bundled-skills/setup-matt-pocock-skills/triage-labels.md +15 -0
- package/bundled-skills/setup-pre-commit/SKILL.md +91 -0
- package/bundled-skills/subagent-driven-development/SKILL.md +418 -0
- package/bundled-skills/subagent-driven-development/implementer-prompt.md +139 -0
- package/bundled-skills/subagent-driven-development/scripts/review-package +44 -0
- package/bundled-skills/subagent-driven-development/scripts/sdd-workspace +22 -0
- package/bundled-skills/subagent-driven-development/scripts/task-brief +40 -0
- package/bundled-skills/subagent-driven-development/task-reviewer-prompt.md +188 -0
- package/bundled-skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/bundled-skills/systematic-debugging/SKILL.md +296 -0
- package/bundled-skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/bundled-skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/bundled-skills/systematic-debugging/defense-in-depth.md +122 -0
- package/bundled-skills/systematic-debugging/find-polluter.sh +63 -0
- package/bundled-skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/bundled-skills/systematic-debugging/test-academic.md +14 -0
- package/bundled-skills/systematic-debugging/test-pressure-1.md +58 -0
- package/bundled-skills/systematic-debugging/test-pressure-2.md +68 -0
- package/bundled-skills/systematic-debugging/test-pressure-3.md +69 -0
- package/bundled-skills/tdd/SKILL.md +108 -0
- package/bundled-skills/tdd/mocking.md +59 -0
- package/bundled-skills/tdd/refactoring.md +10 -0
- package/bundled-skills/tdd/tests.md +61 -0
- package/bundled-skills/teach/GLOSSARY-FORMAT.md +35 -0
- package/bundled-skills/teach/LEARNING-RECORD-FORMAT.md +46 -0
- package/bundled-skills/teach/MISSION-FORMAT.md +31 -0
- package/bundled-skills/teach/RESOURCES-FORMAT.md +32 -0
- package/bundled-skills/teach/SKILL.md +140 -0
- package/bundled-skills/test-driven-development/SKILL.md +371 -0
- package/bundled-skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/bundled-skills/to-issues/SKILL.md +84 -0
- package/bundled-skills/to-prd/SKILL.md +75 -0
- package/bundled-skills/triage/AGENT-BRIEF.md +207 -0
- package/bundled-skills/triage/OUT-OF-SCOPE.md +105 -0
- package/bundled-skills/triage/SKILL.md +112 -0
- package/bundled-skills/using-git-worktrees/SKILL.md +202 -0
- package/bundled-skills/using-superpowers/SKILL.md +121 -0
- package/bundled-skills/using-superpowers/references/antigravity-tools.md +96 -0
- package/bundled-skills/using-superpowers/references/claude-code-tools.md +50 -0
- package/bundled-skills/using-superpowers/references/codex-tools.md +72 -0
- package/bundled-skills/using-superpowers/references/copilot-tools.md +49 -0
- package/bundled-skills/using-superpowers/references/gemini-tools.md +63 -0
- package/bundled-skills/using-superpowers/references/pi-tools.md +28 -0
- package/bundled-skills/verification-before-completion/SKILL.md +139 -0
- package/bundled-skills/writing-great-skills/GLOSSARY.md +195 -0
- package/bundled-skills/writing-great-skills/SKILL.md +82 -0
- package/bundled-skills/writing-plans/SKILL.md +174 -0
- package/bundled-skills/writing-plans/plan-document-reviewer-prompt.md +49 -0
- package/bundled-skills/writing-skills/SKILL.md +689 -0
- package/bundled-skills/writing-skills/anthropic-best-practices.md +1150 -0
- package/bundled-skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/bundled-skills/writing-skills/graphviz-conventions.dot +172 -0
- package/bundled-skills/writing-skills/persuasion-principles.md +187 -0
- package/bundled-skills/writing-skills/render-graphs.js +168 -0
- package/bundled-skills/writing-skills/testing-skills-with-subagents.md +384 -0
- package/commands/add.js +97 -0
- package/commands/check.js +54 -0
- package/commands/exportSkills.js +30 -0
- package/commands/hub.js +52 -0
- package/commands/importSkills.js +68 -0
- package/commands/list.js +37 -0
- package/commands/remove.js +59 -0
- package/commands/sync.js +66 -0
- package/commands/update.js +70 -0
- package/index.js +100 -0
- package/lib/banner.js +108 -0
- package/lib/constants.js +10 -0
- package/lib/deps.js +51 -0
- package/lib/hash.js +26 -0
- package/lib/install.js +31 -0
- package/lib/lockfile.js +37 -0
- package/lib/prompts.js +50 -0
- package/lib/scope.js +19 -0
- package/lib/summary.js +108 -0
- package/lib/theme.js +11 -0
- package/package.json +43 -0
- package/skills.json +164 -0
|
@@ -0,0 +1,209 @@
|
|
|
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
|
+
# --idle-timeout-minutes <n> Shut down after n minutes idle (default 240 = 4h).
|
|
15
|
+
# --open Auto-open the browser on the first screen (use only
|
|
16
|
+
# after the user approves the visual companion).
|
|
17
|
+
# --foreground Run server in the current terminal (no backgrounding).
|
|
18
|
+
# --background Force background mode (overrides Codex auto-foreground).
|
|
19
|
+
|
|
20
|
+
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
21
|
+
|
|
22
|
+
# Parse arguments
|
|
23
|
+
PROJECT_DIR=""
|
|
24
|
+
FOREGROUND="false"
|
|
25
|
+
FORCE_BACKGROUND="false"
|
|
26
|
+
BIND_HOST="127.0.0.1"
|
|
27
|
+
URL_HOST=""
|
|
28
|
+
IDLE_TIMEOUT_MINUTES=""
|
|
29
|
+
while [[ $# -gt 0 ]]; do
|
|
30
|
+
case "$1" in
|
|
31
|
+
--project-dir)
|
|
32
|
+
PROJECT_DIR="$2"
|
|
33
|
+
shift 2
|
|
34
|
+
;;
|
|
35
|
+
--host)
|
|
36
|
+
BIND_HOST="$2"
|
|
37
|
+
shift 2
|
|
38
|
+
;;
|
|
39
|
+
--url-host)
|
|
40
|
+
URL_HOST="$2"
|
|
41
|
+
shift 2
|
|
42
|
+
;;
|
|
43
|
+
--idle-timeout-minutes)
|
|
44
|
+
IDLE_TIMEOUT_MINUTES="$2"
|
|
45
|
+
shift 2
|
|
46
|
+
;;
|
|
47
|
+
--open)
|
|
48
|
+
export BRAINSTORM_OPEN=1
|
|
49
|
+
shift
|
|
50
|
+
;;
|
|
51
|
+
--foreground|--no-daemon)
|
|
52
|
+
FOREGROUND="true"
|
|
53
|
+
shift
|
|
54
|
+
;;
|
|
55
|
+
--background|--daemon)
|
|
56
|
+
FORCE_BACKGROUND="true"
|
|
57
|
+
shift
|
|
58
|
+
;;
|
|
59
|
+
*)
|
|
60
|
+
echo "{\"error\": \"Unknown argument: $1\"}"
|
|
61
|
+
exit 1
|
|
62
|
+
;;
|
|
63
|
+
esac
|
|
64
|
+
done
|
|
65
|
+
|
|
66
|
+
if [[ -z "$URL_HOST" ]]; then
|
|
67
|
+
if [[ "$BIND_HOST" == "127.0.0.1" || "$BIND_HOST" == "localhost" ]]; then
|
|
68
|
+
URL_HOST="localhost"
|
|
69
|
+
else
|
|
70
|
+
URL_HOST="$BIND_HOST"
|
|
71
|
+
fi
|
|
72
|
+
fi
|
|
73
|
+
|
|
74
|
+
if [[ -n "$IDLE_TIMEOUT_MINUTES" ]]; then
|
|
75
|
+
if ! [[ "$IDLE_TIMEOUT_MINUTES" =~ ^[0-9]+$ ]] || [[ "$IDLE_TIMEOUT_MINUTES" -lt 1 ]]; then
|
|
76
|
+
echo "{\"error\": \"--idle-timeout-minutes must be a positive integer\"}"
|
|
77
|
+
exit 1
|
|
78
|
+
fi
|
|
79
|
+
export BRAINSTORM_IDLE_TIMEOUT_MS=$(( IDLE_TIMEOUT_MINUTES * 60 * 1000 ))
|
|
80
|
+
fi
|
|
81
|
+
|
|
82
|
+
is_windows_like_shell() {
|
|
83
|
+
case "${OSTYPE:-}" in
|
|
84
|
+
msys*|cygwin*|mingw*) return 0 ;;
|
|
85
|
+
esac
|
|
86
|
+
if [[ -n "${MSYSTEM:-}" ]]; then
|
|
87
|
+
return 0
|
|
88
|
+
fi
|
|
89
|
+
local uname_s
|
|
90
|
+
uname_s="$(uname -s 2>/dev/null || true)"
|
|
91
|
+
case "$uname_s" in
|
|
92
|
+
MSYS*|MINGW*|CYGWIN*) return 0 ;;
|
|
93
|
+
esac
|
|
94
|
+
return 1
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
# Some environments reap detached/background processes. Auto-foreground when detected.
|
|
98
|
+
if [[ -n "${CODEX_CI:-}" && "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
|
|
99
|
+
FOREGROUND="true"
|
|
100
|
+
fi
|
|
101
|
+
|
|
102
|
+
# Windows/Git Bash reaps nohup background processes. Auto-foreground when detected.
|
|
103
|
+
if [[ "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
|
|
104
|
+
if is_windows_like_shell; then
|
|
105
|
+
FOREGROUND="true"
|
|
106
|
+
fi
|
|
107
|
+
fi
|
|
108
|
+
|
|
109
|
+
# Session files (server.log, server-info, .last-token) embed the session key —
|
|
110
|
+
# keep everything this script and the server create owner-only.
|
|
111
|
+
umask 077
|
|
112
|
+
|
|
113
|
+
# Generate unique session directory
|
|
114
|
+
SESSION_ID="$$-$(date +%s)"
|
|
115
|
+
|
|
116
|
+
if [[ -n "$PROJECT_DIR" ]]; then
|
|
117
|
+
SESSION_DIR="${PROJECT_DIR}/.superpowers/brainstorm/${SESSION_ID}"
|
|
118
|
+
# Persist the bound port and key per project so a restart reuses them and an
|
|
119
|
+
# already-open browser tab reconnects to the same URL with a valid cookie.
|
|
120
|
+
export BRAINSTORM_PORT_FILE="${PROJECT_DIR}/.superpowers/brainstorm/.last-port"
|
|
121
|
+
export BRAINSTORM_TOKEN_FILE="${PROJECT_DIR}/.superpowers/brainstorm/.last-token"
|
|
122
|
+
else
|
|
123
|
+
SESSION_DIR="/tmp/brainstorm-${SESSION_ID}"
|
|
124
|
+
fi
|
|
125
|
+
|
|
126
|
+
STATE_DIR="${SESSION_DIR}/state"
|
|
127
|
+
PID_FILE="${STATE_DIR}/server.pid"
|
|
128
|
+
LOG_FILE="${STATE_DIR}/server.log"
|
|
129
|
+
SERVER_ID_FILE="${STATE_DIR}/server-instance-id"
|
|
130
|
+
|
|
131
|
+
# Create fresh session directory with content and state peers
|
|
132
|
+
mkdir -p "${SESSION_DIR}/content" "$STATE_DIR"
|
|
133
|
+
|
|
134
|
+
SERVER_ID=""
|
|
135
|
+
if [[ -r /dev/urandom ]]; then
|
|
136
|
+
SERVER_ID="$(od -An -N24 -tx1 /dev/urandom 2>/dev/null | tr -d ' \n' || true)"
|
|
137
|
+
fi
|
|
138
|
+
if ! [[ "$SERVER_ID" =~ ^[A-Za-z0-9_-]{32,64}$ ]]; then
|
|
139
|
+
SERVER_ID="$(printf '%08x%08x%08x%08x' "$$" "$(date +%s)" "${RANDOM:-0}" "${RANDOM:-0}")"
|
|
140
|
+
fi
|
|
141
|
+
printf '%s\n' "$SERVER_ID" > "$SERVER_ID_FILE"
|
|
142
|
+
chmod 600 "$SERVER_ID_FILE" 2>/dev/null || true
|
|
143
|
+
|
|
144
|
+
# Kill any existing server
|
|
145
|
+
if [[ -f "$PID_FILE" ]]; then
|
|
146
|
+
old_pid=$(cat "$PID_FILE")
|
|
147
|
+
kill "$old_pid" 2>/dev/null
|
|
148
|
+
rm -f "$PID_FILE"
|
|
149
|
+
fi
|
|
150
|
+
|
|
151
|
+
cd "$SCRIPT_DIR" || exit 1
|
|
152
|
+
|
|
153
|
+
# Resolve the harness PID (grandparent of this script).
|
|
154
|
+
# $PPID is the ephemeral shell the harness spawned to run us — it dies
|
|
155
|
+
# when this script exits. The harness itself is $PPID's parent.
|
|
156
|
+
OWNER_PID="$(ps -o ppid= -p "$PPID" 2>/dev/null | tr -d ' ')"
|
|
157
|
+
if [[ -z "$OWNER_PID" || "$OWNER_PID" == "1" ]]; then
|
|
158
|
+
OWNER_PID="$PPID"
|
|
159
|
+
fi
|
|
160
|
+
|
|
161
|
+
# Windows/MSYS2: Node.js cannot see POSIX PIDs from the MSYS2 namespace.
|
|
162
|
+
# Passing a PID node cannot verify causes server to log owner-pid-invalid
|
|
163
|
+
# and self-terminate at the 60-second lifecycle check. Clear it so the
|
|
164
|
+
# watchdog is disabled and the idle timeout becomes the only shutdown trigger.
|
|
165
|
+
if is_windows_like_shell; then
|
|
166
|
+
OWNER_PID=""
|
|
167
|
+
fi
|
|
168
|
+
|
|
169
|
+
# Foreground mode for environments that reap detached/background processes.
|
|
170
|
+
if [[ "$FOREGROUND" == "true" ]]; then
|
|
171
|
+
env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs "--brainstorm-server-id=$SERVER_ID" &
|
|
172
|
+
SERVER_PID=$!
|
|
173
|
+
echo "$SERVER_PID" > "$PID_FILE"
|
|
174
|
+
wait "$SERVER_PID"
|
|
175
|
+
exit $?
|
|
176
|
+
fi
|
|
177
|
+
|
|
178
|
+
# Start server, capturing output to log file
|
|
179
|
+
# Use nohup to survive shell exit; disown to remove from job table
|
|
180
|
+
nohup env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs "--brainstorm-server-id=$SERVER_ID" > "$LOG_FILE" 2>&1 &
|
|
181
|
+
SERVER_PID=$!
|
|
182
|
+
disown "$SERVER_PID" 2>/dev/null
|
|
183
|
+
echo "$SERVER_PID" > "$PID_FILE"
|
|
184
|
+
|
|
185
|
+
# Wait for server-started message (check log file)
|
|
186
|
+
for _ in {1..50}; do
|
|
187
|
+
if grep -q "server-started" "$LOG_FILE" 2>/dev/null; then
|
|
188
|
+
# Verify server is still alive after a short window (catches process reapers)
|
|
189
|
+
alive="true"
|
|
190
|
+
for _ in {1..20}; do
|
|
191
|
+
if ! kill -0 "$SERVER_PID" 2>/dev/null; then
|
|
192
|
+
alive="false"
|
|
193
|
+
break
|
|
194
|
+
fi
|
|
195
|
+
sleep 0.1
|
|
196
|
+
done
|
|
197
|
+
if [[ "$alive" != "true" ]]; then
|
|
198
|
+
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\"}"
|
|
199
|
+
exit 1
|
|
200
|
+
fi
|
|
201
|
+
grep "server-started" "$LOG_FILE" | head -1
|
|
202
|
+
exit 0
|
|
203
|
+
fi
|
|
204
|
+
sleep 0.1
|
|
205
|
+
done
|
|
206
|
+
|
|
207
|
+
# Timeout - server didn't start
|
|
208
|
+
echo '{"error": "Server failed to start within 5 seconds"}'
|
|
209
|
+
exit 1
|
|
@@ -0,0 +1,120 @@
|
|
|
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
|
+
SERVER_ID_FILE="${STATE_DIR}/server-instance-id"
|
|
19
|
+
|
|
20
|
+
mark_stopped() {
|
|
21
|
+
local reason="$1"
|
|
22
|
+
rm -f "${STATE_DIR}/server-info"
|
|
23
|
+
printf '{"reason":"%s","timestamp":%s}\n' "$reason" "$(date +%s)" > "${STATE_DIR}/server-stopped"
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
read_expected_server_id() {
|
|
27
|
+
[[ -f "$SERVER_ID_FILE" ]] || return 1
|
|
28
|
+
local id
|
|
29
|
+
id="$(tr -d '\r\n' < "$SERVER_ID_FILE" 2>/dev/null || true)"
|
|
30
|
+
[[ "$id" =~ ^[A-Za-z0-9_-]{32,64}$ ]] || return 1
|
|
31
|
+
printf '%s\n' "$id"
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
command_line_for_pid() {
|
|
35
|
+
local pid="$1"
|
|
36
|
+
if [[ -r "/proc/$pid/cmdline" ]]; then
|
|
37
|
+
tr '\0' '\n' < "/proc/$pid/cmdline" 2>/dev/null || true
|
|
38
|
+
return 0
|
|
39
|
+
fi
|
|
40
|
+
ps -ww -p "$pid" -o command= 2>/dev/null || ps -f -p "$pid" 2>/dev/null | sed '1d' || true
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
command_has_server_id() {
|
|
44
|
+
local pid="$1"
|
|
45
|
+
local expected="$2"
|
|
46
|
+
local expected_arg="--brainstorm-server-id=$expected"
|
|
47
|
+
if [[ -r "/proc/$pid/cmdline" ]]; then
|
|
48
|
+
local arg
|
|
49
|
+
while IFS= read -r -d '' arg || [[ -n "$arg" ]]; do
|
|
50
|
+
[[ "$arg" == "$expected_arg" ]] && return 0
|
|
51
|
+
done < "/proc/$pid/cmdline"
|
|
52
|
+
return 1
|
|
53
|
+
fi
|
|
54
|
+
local command_line
|
|
55
|
+
command_line="$(command_line_for_pid "$pid")"
|
|
56
|
+
[[ -n "$command_line" ]] || return 1
|
|
57
|
+
case " $command_line " in
|
|
58
|
+
*" $expected_arg "*) return 0 ;;
|
|
59
|
+
*) return 1 ;;
|
|
60
|
+
esac
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
# Confirm a PID has this session's per-start instance id, not just a familiar
|
|
64
|
+
# process name. Ambiguous or legacy metadata fails closed as stale_pid.
|
|
65
|
+
is_brainstorm_server() {
|
|
66
|
+
kill -0 "$1" 2>/dev/null || return 1
|
|
67
|
+
local expected_id
|
|
68
|
+
expected_id="$(read_expected_server_id)" || return 1
|
|
69
|
+
command_has_server_id "$1" "$expected_id" || return 1
|
|
70
|
+
return 0
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if [[ -f "$PID_FILE" ]]; then
|
|
74
|
+
pid=$(cat "$PID_FILE")
|
|
75
|
+
|
|
76
|
+
# Refuse to signal a PID we can't prove is our server. A stale pid file may
|
|
77
|
+
# point at an unrelated process after a reboot/PID wraparound.
|
|
78
|
+
if ! is_brainstorm_server "$pid"; then
|
|
79
|
+
rm -f "$PID_FILE" "$SERVER_ID_FILE"
|
|
80
|
+
mark_stopped "stale_pid"
|
|
81
|
+
echo '{"status": "stale_pid"}'
|
|
82
|
+
exit 0
|
|
83
|
+
fi
|
|
84
|
+
|
|
85
|
+
# Try to stop gracefully, fallback to force if still alive
|
|
86
|
+
kill "$pid" 2>/dev/null || true
|
|
87
|
+
|
|
88
|
+
# Wait for graceful shutdown (up to ~2s)
|
|
89
|
+
for _ in {1..20}; do
|
|
90
|
+
if ! kill -0 "$pid" 2>/dev/null; then
|
|
91
|
+
break
|
|
92
|
+
fi
|
|
93
|
+
sleep 0.1
|
|
94
|
+
done
|
|
95
|
+
|
|
96
|
+
# If still running, escalate to SIGKILL
|
|
97
|
+
if kill -0 "$pid" 2>/dev/null; then
|
|
98
|
+
kill -9 "$pid" 2>/dev/null || true
|
|
99
|
+
|
|
100
|
+
# Give SIGKILL a moment to take effect
|
|
101
|
+
sleep 0.1
|
|
102
|
+
fi
|
|
103
|
+
|
|
104
|
+
if kill -0 "$pid" 2>/dev/null; then
|
|
105
|
+
echo '{"status": "failed", "error": "process still running"}'
|
|
106
|
+
exit 1
|
|
107
|
+
fi
|
|
108
|
+
|
|
109
|
+
rm -f "$PID_FILE" "$SERVER_ID_FILE" "${STATE_DIR}/server.log"
|
|
110
|
+
mark_stopped "stop-server.sh"
|
|
111
|
+
|
|
112
|
+
# Only delete ephemeral /tmp directories
|
|
113
|
+
if [[ "$SESSION_DIR" == /tmp/* ]]; then
|
|
114
|
+
rm -rf "$SESSION_DIR"
|
|
115
|
+
fi
|
|
116
|
+
|
|
117
|
+
echo '{"status": "stopped"}'
|
|
118
|
+
else
|
|
119
|
+
echo '{"status": "not_running"}'
|
|
120
|
+
fi
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Spec Document Reviewer Prompt Template
|
|
2
|
+
|
|
3
|
+
Use this template when dispatching a spec document reviewer subagent.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Verify the spec is complete, consistent, and ready for implementation planning.
|
|
6
|
+
|
|
7
|
+
**Dispatch after:** Spec document is written to docs/superpowers/specs/
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
Subagent (general-purpose):
|
|
11
|
+
description: "Review spec document"
|
|
12
|
+
prompt: |
|
|
13
|
+
You are a spec document reviewer. Verify this spec is complete and ready for planning.
|
|
14
|
+
|
|
15
|
+
**Spec to review:** [SPEC_FILE_PATH]
|
|
16
|
+
|
|
17
|
+
## What to Check
|
|
18
|
+
|
|
19
|
+
| Category | What to Look For |
|
|
20
|
+
|----------|------------------|
|
|
21
|
+
| Completeness | TODOs, placeholders, "TBD", incomplete sections |
|
|
22
|
+
| Consistency | Internal contradictions, conflicting requirements |
|
|
23
|
+
| Clarity | Requirements ambiguous enough to cause someone to build the wrong thing |
|
|
24
|
+
| Scope | Focused enough for a single plan — not covering multiple independent subsystems |
|
|
25
|
+
| YAGNI | Unrequested features, over-engineering |
|
|
26
|
+
|
|
27
|
+
## Calibration
|
|
28
|
+
|
|
29
|
+
**Only flag issues that would cause real problems during implementation planning.**
|
|
30
|
+
A missing section, a contradiction, or a requirement so ambiguous it could be
|
|
31
|
+
interpreted two different ways — those are issues. Minor wording improvements,
|
|
32
|
+
stylistic preferences, and "sections less detailed than others" are not.
|
|
33
|
+
|
|
34
|
+
Approve unless there are serious gaps that would lead to a flawed plan.
|
|
35
|
+
|
|
36
|
+
## Output Format
|
|
37
|
+
|
|
38
|
+
## Spec Review
|
|
39
|
+
|
|
40
|
+
**Status:** Approved | Issues Found
|
|
41
|
+
|
|
42
|
+
**Issues (if any):**
|
|
43
|
+
- [Section X]: [specific issue] - [why it matters for planning]
|
|
44
|
+
|
|
45
|
+
**Recommendations (advisory, do not block approval):**
|
|
46
|
+
- [suggestions for improvement]
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
**Reviewer returns:** Status, Issues (if any), Recommendations
|
|
@@ -0,0 +1,298 @@
|
|
|
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, connection status, 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 AFTER the user approves the companion. --open auto-opens their browser on
|
|
37
|
+
# the first screen; --project-dir persists mockups and enables same-port restart.
|
|
38
|
+
scripts/start-server.sh --project-dir /path/to/project --open
|
|
39
|
+
|
|
40
|
+
# Returns: {"type":"server-started","port":52341,
|
|
41
|
+
# "url":"http://localhost:52341/?key=ab12…",
|
|
42
|
+
# "screen_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/content",
|
|
43
|
+
# "state_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/state"}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Save `screen_dir` and `state_dir` from the response. With `--open`, the browser opens itself when you push the first screen — you don't need to ask the user to open it, but still share the URL as a fallback (headless/remote setups won't auto-open).
|
|
47
|
+
|
|
48
|
+
**The URL contains a session key (`?key=…`).** The server rejects any request
|
|
49
|
+
without it, so always give the user the **complete** URL from the `url` field —
|
|
50
|
+
never strip the query string, and never hand out a bare `http://host:port`. The
|
|
51
|
+
key gates HTTP and WebSocket access so a stray browser tab or another machine on
|
|
52
|
+
the network can't read the screens or inject events. After the first load the
|
|
53
|
+
browser remembers the key via a cookie, so reloads and `/files/*` assets work
|
|
54
|
+
without repeating it.
|
|
55
|
+
|
|
56
|
+
**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.
|
|
57
|
+
|
|
58
|
+
**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.
|
|
59
|
+
|
|
60
|
+
**Launching the server by platform:**
|
|
61
|
+
|
|
62
|
+
**Claude Code:**
|
|
63
|
+
```bash
|
|
64
|
+
# Default mode works — the script backgrounds the server itself.
|
|
65
|
+
scripts/start-server.sh --project-dir /path/to/project --open
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
On Windows, the script auto-detects and switches to foreground mode (which blocks the tool call). Use `run_in_background: true` on the Bash tool call so the server survives across conversation turns, then read `$STATE_DIR/server-info` on the next turn to get the URL and port.
|
|
69
|
+
|
|
70
|
+
**Codex:**
|
|
71
|
+
```bash
|
|
72
|
+
# Codex reaps background processes. The script auto-detects CODEX_CI and
|
|
73
|
+
# switches to foreground mode. Run it normally — no extra flags needed.
|
|
74
|
+
scripts/start-server.sh --project-dir /path/to/project --open
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Gemini CLI:**
|
|
78
|
+
```bash
|
|
79
|
+
# Use --foreground and set is_background: true on your shell tool call
|
|
80
|
+
# so the process survives across turns
|
|
81
|
+
scripts/start-server.sh --project-dir /path/to/project --open --foreground
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Copilot CLI:**
|
|
85
|
+
```bash
|
|
86
|
+
# Use --foreground and start the server via the bash tool with mode: "async"
|
|
87
|
+
# so the process survives across turns. Capture the returned shellId for
|
|
88
|
+
# read_bash / stop_bash if you need to interact with it later.
|
|
89
|
+
scripts/start-server.sh --project-dir /path/to/project --open --foreground
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**Other environments:** The server must keep running in the background across conversation turns. If your environment reaps detached processes, use `--foreground` and launch the command with your platform's background execution mechanism.
|
|
93
|
+
|
|
94
|
+
If the URL is unreachable from your browser (common in remote/containerized setups), bind a non-loopback host:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
scripts/start-server.sh \
|
|
98
|
+
--project-dir /path/to/project \
|
|
99
|
+
--host 0.0.0.0 \
|
|
100
|
+
--url-host localhost
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Use `--url-host` to control what hostname is printed in the returned URL JSON.
|
|
104
|
+
|
|
105
|
+
## The Loop
|
|
106
|
+
|
|
107
|
+
1. **Check server is alive**, then **write HTML** to a new file in `screen_dir`:
|
|
108
|
+
- **Required: confirm the server is alive before referring to the URL or pushing a screen.** Check that `$STATE_DIR/server-info` exists and `$STATE_DIR/server-stopped` does not. If it has shut down, restart it with `start-server.sh` using the **same `--project-dir`** — it reuses the same port, so the user's open tab reconnects on its own (it shows a "paused" overlay while the server is down) and you don't need to send a new URL. The server auto-exits after 4 hours idle (configurable with `--idle-timeout-minutes`).
|
|
109
|
+
- Use semantic filenames: `platform.html`, `visual-style.html`, `layout.html`
|
|
110
|
+
- **Never reuse filenames** — each screen gets a fresh file
|
|
111
|
+
- Use your file-creation tool — **never use cat/heredoc** (dumps noise into terminal)
|
|
112
|
+
- Server automatically serves the newest file
|
|
113
|
+
|
|
114
|
+
2. **Tell user what to expect and end your turn:**
|
|
115
|
+
- Remind them of the URL (every step, not just first)
|
|
116
|
+
- Give a brief text summary of what's on screen (e.g., "Showing 3 layout options for the homepage")
|
|
117
|
+
- 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."
|
|
118
|
+
|
|
119
|
+
3. **On your next turn** — after the user responds in the terminal:
|
|
120
|
+
- Read `$STATE_DIR/events` if it exists — this contains the user's browser interactions (clicks, selections) as JSON lines
|
|
121
|
+
- Merge with the user's terminal text to get the full picture
|
|
122
|
+
- The terminal message is the primary feedback; `state_dir/events` provides structured interaction data
|
|
123
|
+
|
|
124
|
+
4. **Iterate or advance** — if feedback changes current screen, write a new file (e.g., `layout-v2.html`). Only move to the next question when the current step is validated.
|
|
125
|
+
|
|
126
|
+
5. **Unload when returning to terminal** — when the next step doesn't need the browser (e.g., a clarifying question, a tradeoff discussion), push a waiting screen to clear the stale content:
|
|
127
|
+
|
|
128
|
+
```html
|
|
129
|
+
<!-- filename: waiting.html (or waiting-2.html, etc.) -->
|
|
130
|
+
<div style="display:flex;align-items:center;justify-content:center;min-height:60vh">
|
|
131
|
+
<p class="subtitle">Continuing in terminal...</p>
|
|
132
|
+
</div>
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
This prevents the user from staring at a resolved choice while the conversation has moved on. When the next visual question comes up, push a new content file as usual.
|
|
136
|
+
|
|
137
|
+
6. Repeat until done.
|
|
138
|
+
|
|
139
|
+
## Writing Content Fragments
|
|
140
|
+
|
|
141
|
+
Write just the content that goes inside the page. The server wraps it in the frame template automatically (header, theme CSS, connection status, and all interactive infrastructure).
|
|
142
|
+
|
|
143
|
+
**Minimal example:**
|
|
144
|
+
|
|
145
|
+
```html
|
|
146
|
+
<h2>Which layout works better?</h2>
|
|
147
|
+
<p class="subtitle">Consider readability and visual hierarchy</p>
|
|
148
|
+
|
|
149
|
+
<div class="options">
|
|
150
|
+
<div class="option" data-choice="a" onclick="toggleSelect(this)">
|
|
151
|
+
<div class="letter">A</div>
|
|
152
|
+
<div class="content">
|
|
153
|
+
<h3>Single Column</h3>
|
|
154
|
+
<p>Clean, focused reading experience</p>
|
|
155
|
+
</div>
|
|
156
|
+
</div>
|
|
157
|
+
<div class="option" data-choice="b" onclick="toggleSelect(this)">
|
|
158
|
+
<div class="letter">B</div>
|
|
159
|
+
<div class="content">
|
|
160
|
+
<h3>Two Column</h3>
|
|
161
|
+
<p>Sidebar navigation with main content</p>
|
|
162
|
+
</div>
|
|
163
|
+
</div>
|
|
164
|
+
</div>
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
That's it. No `<html>`, no CSS, no `<script>` tags needed. The server provides all of that.
|
|
168
|
+
|
|
169
|
+
## CSS Classes Available
|
|
170
|
+
|
|
171
|
+
The frame template provides these CSS classes for your content:
|
|
172
|
+
|
|
173
|
+
### Options (A/B/C choices)
|
|
174
|
+
|
|
175
|
+
```html
|
|
176
|
+
<div class="options">
|
|
177
|
+
<div class="option" data-choice="a" onclick="toggleSelect(this)">
|
|
178
|
+
<div class="letter">A</div>
|
|
179
|
+
<div class="content">
|
|
180
|
+
<h3>Title</h3>
|
|
181
|
+
<p>Description</p>
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
**Multi-select:** Add `data-multiselect` to the container to let users select multiple options. Each click toggles the item's selected styling.
|
|
188
|
+
|
|
189
|
+
```html
|
|
190
|
+
<div class="options" data-multiselect>
|
|
191
|
+
<!-- same option markup — users can select/deselect multiple -->
|
|
192
|
+
</div>
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Cards (visual designs)
|
|
196
|
+
|
|
197
|
+
```html
|
|
198
|
+
<div class="cards">
|
|
199
|
+
<div class="card" data-choice="design1" onclick="toggleSelect(this)">
|
|
200
|
+
<div class="card-image"><!-- mockup content --></div>
|
|
201
|
+
<div class="card-body">
|
|
202
|
+
<h3>Name</h3>
|
|
203
|
+
<p>Description</p>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
</div>
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Mockup container
|
|
210
|
+
|
|
211
|
+
```html
|
|
212
|
+
<div class="mockup">
|
|
213
|
+
<div class="mockup-header">Preview: Dashboard Layout</div>
|
|
214
|
+
<div class="mockup-body"><!-- your mockup HTML --></div>
|
|
215
|
+
</div>
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
### Split view (side-by-side)
|
|
219
|
+
|
|
220
|
+
```html
|
|
221
|
+
<div class="split">
|
|
222
|
+
<div class="mockup"><!-- left --></div>
|
|
223
|
+
<div class="mockup"><!-- right --></div>
|
|
224
|
+
</div>
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Pros/Cons
|
|
228
|
+
|
|
229
|
+
```html
|
|
230
|
+
<div class="pros-cons">
|
|
231
|
+
<div class="pros"><h4>Pros</h4><ul><li>Benefit</li></ul></div>
|
|
232
|
+
<div class="cons"><h4>Cons</h4><ul><li>Drawback</li></ul></div>
|
|
233
|
+
</div>
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Mock elements (wireframe building blocks)
|
|
237
|
+
|
|
238
|
+
```html
|
|
239
|
+
<div class="mock-nav">Logo | Home | About | Contact</div>
|
|
240
|
+
<div style="display: flex;">
|
|
241
|
+
<div class="mock-sidebar">Navigation</div>
|
|
242
|
+
<div class="mock-content">Main content area</div>
|
|
243
|
+
</div>
|
|
244
|
+
<button class="mock-button">Action Button</button>
|
|
245
|
+
<input class="mock-input" placeholder="Input field">
|
|
246
|
+
<div class="placeholder">Placeholder area</div>
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Typography and sections
|
|
250
|
+
|
|
251
|
+
- `h2` — page title
|
|
252
|
+
- `h3` — section heading
|
|
253
|
+
- `.subtitle` — secondary text below title
|
|
254
|
+
- `.section` — content block with bottom margin
|
|
255
|
+
- `.label` — small uppercase label text
|
|
256
|
+
|
|
257
|
+
## Browser Events Format
|
|
258
|
+
|
|
259
|
+
When the user clicks options in the browser, their interactions are recorded to `$STATE_DIR/events` (one JSON object per line). The file is cleared automatically when you push a new screen.
|
|
260
|
+
|
|
261
|
+
```jsonl
|
|
262
|
+
{"type":"click","choice":"a","text":"Option A - Simple Layout","timestamp":1706000101}
|
|
263
|
+
{"type":"click","choice":"c","text":"Option C - Complex Grid","timestamp":1706000108}
|
|
264
|
+
{"type":"click","choice":"b","text":"Option B - Hybrid","timestamp":1706000115}
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
The full event stream shows the user's exploration path — they may click multiple options before settling. The last `choice` event is typically the final selection, but the pattern of clicks can reveal hesitation or preferences worth asking about.
|
|
268
|
+
|
|
269
|
+
If `$STATE_DIR/events` doesn't exist, the user didn't interact with the browser — use only their terminal text.
|
|
270
|
+
|
|
271
|
+
## Design Tips
|
|
272
|
+
|
|
273
|
+
- **Scale fidelity to the question** — wireframes for layout, polish for polish questions
|
|
274
|
+
- **Explain the question on each page** — "Which layout feels more professional?" not just "Pick one"
|
|
275
|
+
- **Iterate before advancing** — if feedback changes current screen, write a new version
|
|
276
|
+
- **2-4 options max** per screen
|
|
277
|
+
- **Use real content when it matters** — for a photography portfolio, use actual images (Unsplash). Placeholder content obscures design issues.
|
|
278
|
+
- **Keep mockups simple** — focus on layout and structure, not pixel-perfect design
|
|
279
|
+
|
|
280
|
+
## File Naming
|
|
281
|
+
|
|
282
|
+
- Use semantic names: `platform.html`, `visual-style.html`, `layout.html`
|
|
283
|
+
- Never reuse filenames — each screen must be a new file
|
|
284
|
+
- For iterations: append version suffix like `layout-v2.html`, `layout-v3.html`
|
|
285
|
+
- Server serves newest file by modification time
|
|
286
|
+
|
|
287
|
+
## Cleaning Up
|
|
288
|
+
|
|
289
|
+
```bash
|
|
290
|
+
scripts/stop-server.sh $SESSION_DIR
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
If the session used `--project-dir`, mockup files persist in `.superpowers/brainstorm/` for later reference. Only `/tmp` sessions get deleted on stop.
|
|
294
|
+
|
|
295
|
+
## Reference
|
|
296
|
+
|
|
297
|
+
- Frame template (CSS reference): `scripts/frame-template.html`
|
|
298
|
+
- Helper script (client-side): `scripts/helper.js`
|