superbrain-server 1.0.2-beta.0 → 1.0.2-beta.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 +107 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# superbrain-server
|
|
2
|
+
|
|
3
|
+
One-command installer and launcher for the SuperBrain backend.
|
|
4
|
+
|
|
5
|
+
Run the backend on any machine without cloning the repository.
|
|
6
|
+
|
|
7
|
+
## Install and Run
|
|
8
|
+
|
|
9
|
+
### Recommended (no global install)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx -y superbrain-server@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Global install (optional)
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g superbrain-server
|
|
19
|
+
superbrain-server
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Beta channel
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx -y superbrain-server@beta
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## What It Does on First Run
|
|
29
|
+
|
|
30
|
+
1. Unpacks backend files into `~/.superbrain-server`
|
|
31
|
+
2. Creates an isolated Python virtual environment
|
|
32
|
+
3. Installs Python dependencies
|
|
33
|
+
4. Runs interactive setup (AI keys, optional Instagram, token)
|
|
34
|
+
5. Starts the backend API server
|
|
35
|
+
|
|
36
|
+
## Requirements
|
|
37
|
+
|
|
38
|
+
- Node.js 20+
|
|
39
|
+
- Python 3.10+
|
|
40
|
+
- ffmpeg
|
|
41
|
+
|
|
42
|
+
## Commands
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Start server
|
|
46
|
+
superbrain-server
|
|
47
|
+
|
|
48
|
+
# Open interactive reset menu
|
|
49
|
+
superbrain-server reset
|
|
50
|
+
|
|
51
|
+
# Full reset (destructive)
|
|
52
|
+
superbrain-server reset --all
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
You can run the same with npx:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx -y superbrain-server@latest reset
|
|
59
|
+
npx -y superbrain-server@latest reset --all
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Default Runtime Location
|
|
63
|
+
|
|
64
|
+
The backend is installed under your user home directory:
|
|
65
|
+
|
|
66
|
+
- Windows: `%USERPROFILE%/.superbrain-server`
|
|
67
|
+
- macOS/Linux: `~/.superbrain-server`
|
|
68
|
+
|
|
69
|
+
## Connect Mobile App
|
|
70
|
+
|
|
71
|
+
After backend starts:
|
|
72
|
+
|
|
73
|
+
1. Copy the Access Token shown in backend console
|
|
74
|
+
2. Open SuperBrain app Settings
|
|
75
|
+
3. Enter server URL and Access Token
|
|
76
|
+
|
|
77
|
+
## Troubleshooting
|
|
78
|
+
|
|
79
|
+
### Python not found
|
|
80
|
+
|
|
81
|
+
Install Python 3.10+ and verify:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
python --version
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
On Windows, `py -3 --version` should also work.
|
|
88
|
+
|
|
89
|
+
### Backend not reachable from phone
|
|
90
|
+
|
|
91
|
+
Expose local port with ngrok:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
ngrok http 5000
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Use the generated HTTPS URL in app Settings.
|
|
98
|
+
|
|
99
|
+
## Links
|
|
100
|
+
|
|
101
|
+
- GitHub repository: https://github.com/sidinsearch/superbrain
|
|
102
|
+
- Main project docs: https://github.com/sidinsearch/superbrain#readme
|
|
103
|
+
- npm package page: https://www.npmjs.com/package/superbrain-server
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
MIT (CLI wrapper)
|