nano-brain 2.0.0-beta.1 → 2.0.0-beta.3
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 +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,6 +32,28 @@ nano-brain is a persistent memory server for AI coding agents that solves sessio
|
|
|
32
32
|
|
|
33
33
|
## Quick Start
|
|
34
34
|
|
|
35
|
+
### Option A: Via npx (no Go required)
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Start PostgreSQL + pgvector
|
|
39
|
+
docker run -d --name nanobrain-pg -p 5432:5432 \
|
|
40
|
+
-e POSTGRES_USER=nanobrain -e POSTGRES_PASSWORD=nanobrain -e POSTGRES_DB=nanobrain_dev \
|
|
41
|
+
pgvector/pgvector:pg17
|
|
42
|
+
|
|
43
|
+
# Start Ollama + pull embedding model
|
|
44
|
+
ollama pull nomic-embed-text
|
|
45
|
+
|
|
46
|
+
# Check prerequisites
|
|
47
|
+
npx nano-brain@beta doctor
|
|
48
|
+
|
|
49
|
+
# Start server
|
|
50
|
+
npx nano-brain@beta
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> **Note:** Do NOT run `npx nano-brain` from the nano-brain source directory — npm will resolve the local package instead of the registry. Run from any other directory.
|
|
54
|
+
|
|
55
|
+
### Option B: Build from source
|
|
56
|
+
|
|
35
57
|
```bash
|
|
36
58
|
# Build
|
|
37
59
|
CGO_ENABLED=0 go build -o nano-brain ./cmd/nano-brain
|
|
@@ -176,6 +198,7 @@ Workspace is passed in the JSON body for POST, query param for GET.
|
|
|
176
198
|
| `nano-brain logs [-n 50] [-f]` | Tail log file |
|
|
177
199
|
| `nano-brain docker start\|stop\|status` | Docker compose management |
|
|
178
200
|
| `nano-brain status [--json]` | Server status |
|
|
201
|
+
| `nano-brain doctor [--json]` | Check prerequisites (config, PostgreSQL, pgvector, Ollama, model) |
|
|
179
202
|
|
|
180
203
|
## MCP Tools
|
|
181
204
|
|