brainctl 0.1.12 → 0.1.13
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 +20 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,26 +17,11 @@
|
|
|
17
17
|
|
|
18
18
|
## 📦 Install & Set Up
|
|
19
19
|
|
|
20
|
-
> **
|
|
21
|
-
|
|
22
|
-
### 1. Install the CLI
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npm install -g brainctl
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Verify:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
brainctl --version
|
|
32
|
-
brainctl doctor # checks which agents are on your PATH
|
|
33
|
-
```
|
|
20
|
+
> **Zero install required.** Brainctl runs straight from npx — register it as an MCP server in your agent and you're done. No global install, no bin to manage.
|
|
34
21
|
|
|
35
22
|
> **Prerequisite:** at least one of `claude`, `codex`, or `gemini` installed and on your `PATH`.
|
|
36
23
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
### 2. Register `brainctl` as an MCP server (pick your agents)
|
|
24
|
+
### 1. Register `brainctl` as an MCP server (pick your agents)
|
|
40
25
|
|
|
41
26
|
Each agent has its own config file. Brainctl exposes **22 MCP tools** (profiles, sync, skills, run, web UI launch, etc.) — once you register it, any of them can call those tools.
|
|
42
27
|
|
|
@@ -104,14 +89,28 @@ Restart your Gemini session.
|
|
|
104
89
|
|
|
105
90
|
---
|
|
106
91
|
|
|
107
|
-
###
|
|
92
|
+
### 2. Open the dashboard
|
|
93
|
+
|
|
94
|
+
From any MCP-connected agent, just ask:
|
|
95
|
+
|
|
96
|
+
> _"Open the brainctl UI"_
|
|
97
|
+
|
|
98
|
+
It'll start the server **and** open your browser automatically at http://127.0.0.1:3333.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
### Optional: install the CLI globally
|
|
103
|
+
|
|
104
|
+
Prefer a shell command? Install globally:
|
|
108
105
|
|
|
109
106
|
```bash
|
|
110
|
-
brainctl
|
|
111
|
-
|
|
107
|
+
npm install -g brainctl
|
|
108
|
+
brainctl --version
|
|
109
|
+
brainctl doctor # checks which agents are on your PATH
|
|
110
|
+
brainctl ui # launch the dashboard from your terminal
|
|
112
111
|
```
|
|
113
112
|
|
|
114
|
-
|
|
113
|
+
The CLI is entirely optional — everything it does is also available through the MCP tools and the dashboard.
|
|
115
114
|
|
|
116
115
|
---
|
|
117
116
|
|