@onebrain-ai/cli 2.0.13 → 2.1.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 +13 -39
- package/dist/onebrain +2976 -2298
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
</p>
|
|
24
24
|
|
|
25
25
|
<p align="center">
|
|
26
|
-
<a href="#
|
|
26
|
+
<a href="#installation">Get Started →</a> · <a href="#commands">View Commands →</a>
|
|
27
27
|
</p>
|
|
28
28
|
|
|
29
29
|
---
|
|
@@ -79,7 +79,7 @@ Run OneBrain as your personal AI operating system — a complete AI environment
|
|
|
79
79
|
|
|
80
80
|
**Setting up the full stack:**
|
|
81
81
|
|
|
82
|
-
1. Install OneBrain and open your vault in Obsidian ([Get Started](#
|
|
82
|
+
1. Install OneBrain and open your vault in Obsidian ([Get Started](#installation))
|
|
83
83
|
2. Start a tmux session: `tmux new -s onebrain`
|
|
84
84
|
3. Start Claude Code in your vault directory: `claude`
|
|
85
85
|
4. Run `/telegram:configure` to connect Claude Code's built-in Telegram channel — no custom bot or external infra needed
|
|
@@ -168,56 +168,30 @@ OneBrain has three automatic behaviors that run without you doing anything:
|
|
|
168
168
|
|
|
169
169
|
---
|
|
170
170
|
|
|
171
|
-
##
|
|
171
|
+
## Installation
|
|
172
172
|
|
|
173
|
-
###
|
|
174
|
-
|
|
175
|
-
**macOS / Linux:**
|
|
173
|
+
### 1. Install the CLI
|
|
176
174
|
|
|
177
175
|
```bash
|
|
178
|
-
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
**Windows (PowerShell):**
|
|
182
|
-
|
|
183
|
-
```powershell
|
|
184
|
-
irm https://raw.githubusercontent.com/kengio/onebrain/main/install.ps1 | iex
|
|
176
|
+
npm install -g @onebrain-ai/cli
|
|
185
177
|
```
|
|
186
178
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
**Install the CLI binary** (required for auto-checkpoints, `/doctor`, and `/update`):
|
|
179
|
+
### 2. Create and initialize your vault
|
|
190
180
|
|
|
191
181
|
```bash
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
# or with npm
|
|
196
|
-
npm install -g @onebrain-ai/cli
|
|
182
|
+
mkdir my-vault && cd my-vault
|
|
183
|
+
onebrain init
|
|
197
184
|
```
|
|
198
185
|
|
|
199
|
-
|
|
186
|
+
### 3. Open Obsidian
|
|
200
187
|
|
|
201
|
-
|
|
202
|
-
2. **Start your agent** — Open the terminal plugin, run `claude` or `gemini`
|
|
203
|
-
3. **Run `/onboarding`** — 2 minutes to personalize your vault and AI assistant
|
|
188
|
+
File → Open Folder as Vault → select this folder
|
|
204
189
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
### Option 2 — Add to existing vault
|
|
208
|
-
|
|
209
|
-
Run from within your existing vault in Claude Code:
|
|
210
|
-
|
|
211
|
-
```
|
|
212
|
-
/plugin marketplace add kengio/onebrain
|
|
213
|
-
/plugin install onebrain@onebrain
|
|
214
|
-
```
|
|
190
|
+
### 4. Personalize your vault
|
|
215
191
|
|
|
216
|
-
|
|
192
|
+
In Claude Code: `/onboarding`
|
|
217
193
|
|
|
218
|
-
|
|
219
|
-
bun install -g @onebrain-ai/cli # or: npm install -g @onebrain-ai/cli
|
|
220
|
-
```
|
|
194
|
+
> **Adding OneBrain to an existing vault?** `cd` into it and run `onebrain init`
|
|
221
195
|
|
|
222
196
|
---
|
|
223
197
|
|