brainstorm-companion 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -2
- package/package.json +1 -1
- package/src/cli.js +6 -2
package/README.md
CHANGED
|
@@ -12,7 +12,11 @@ Zero dependencies. Node.js >= 18 only.
|
|
|
12
12
|
npm install -g brainstorm-companion
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
### Claude Code
|
|
15
|
+
### Claude Code Setup
|
|
16
|
+
|
|
17
|
+
Two parts: the **MCP server** (gives the agent tools) and the **skill** (teaches the agent how to use them well).
|
|
18
|
+
|
|
19
|
+
#### Step 1: MCP Server
|
|
16
20
|
|
|
17
21
|
Add to `~/.claude/.mcp.json` (create the file if it doesn't exist):
|
|
18
22
|
|
|
@@ -27,7 +31,7 @@ Add to `~/.claude/.mcp.json` (create the file if it doesn't exist):
|
|
|
27
31
|
}
|
|
28
32
|
```
|
|
29
33
|
|
|
30
|
-
|
|
34
|
+
This gives the agent 5 tools: `brainstorm_start_session`, `brainstorm_push_screen`, `brainstorm_read_events`, `brainstorm_clear_screen`, `brainstorm_stop_session`. Full usage docs are embedded in each tool description.
|
|
31
35
|
|
|
32
36
|
**Alternative (no global install):** Use `npx` instead:
|
|
33
37
|
```json
|
|
@@ -41,6 +45,31 @@ Then restart Claude Code. The agent gets 5 tools (`brainstorm_start_session`, `b
|
|
|
41
45
|
}
|
|
42
46
|
```
|
|
43
47
|
|
|
48
|
+
#### Step 2: Skill (optional but recommended)
|
|
49
|
+
|
|
50
|
+
The skill teaches the agent **when and how** to use the brainstorm tools — CSS classes, HTML patterns, workflow patterns, and best practices.
|
|
51
|
+
|
|
52
|
+
Find the skill files path:
|
|
53
|
+
```bash
|
|
54
|
+
echo "$(npm root -g)/brainstorm-companion/skill"
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Then install the skill in Claude Code:
|
|
58
|
+
```bash
|
|
59
|
+
# In Claude Code, run:
|
|
60
|
+
/install-skill $(npm root -g)/brainstorm-companion/skill/SKILL.md
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Or manually copy the skill into your project:
|
|
64
|
+
```bash
|
|
65
|
+
mkdir -p .claude/skills
|
|
66
|
+
cp "$(npm root -g)/brainstorm-companion/skill/"*.md .claude/skills/
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
#### Step 3: Restart Claude Code
|
|
70
|
+
|
|
71
|
+
Restart Claude Code for the MCP server and skill to take effect.
|
|
72
|
+
|
|
44
73
|
---
|
|
45
74
|
|
|
46
75
|
## Complete Usage Guide
|
package/package.json
CHANGED
package/src/cli.js
CHANGED
|
@@ -192,10 +192,14 @@ Next steps:
|
|
|
192
192
|
brainstorm-companion push --html '<h2>Your content</h2>' Push content to browser
|
|
193
193
|
brainstorm-companion push file.html --slot a --label "A" Comparison mode
|
|
194
194
|
brainstorm-companion events Read user interactions
|
|
195
|
+
brainstorm-companion events --wait 120 Wait for user's click
|
|
195
196
|
brainstorm-companion stop Stop when done
|
|
196
197
|
|
|
197
|
-
|
|
198
|
-
|
|
198
|
+
Install skill for AI agents (teaches CSS classes, workflows, best practices):
|
|
199
|
+
/install-skill $(npm root -g)/brainstorm-companion/skill/SKILL.md
|
|
200
|
+
|
|
201
|
+
Docs: https://www.npmjs.com/package/brainstorm-companion
|
|
202
|
+
Help: brainstorm-companion push --help`);
|
|
199
203
|
}
|
|
200
204
|
|
|
201
205
|
function sleep(ms) {
|