SyslogSolution/ra-h-os
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify setup profiles in README

Browse Source
This commit is contained in:
“BeeRad”
2026-05-02 12:51:40 +10:00
parent cdad9d3931
commit 644316974e
2 changed files with 93 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+24 -6
View File
@@ -29,8 +29,8 @@
If you just want RA-H OS working:
1. Use the MCP quick install below if you mainly want agent access.
2. Use the local app quick start if you also want the browser UI.
3. Read [Local Models](../LOCAL-MODELS.md) and [Full Local](./10_full-local.md) if you want a more local-first setup.
2. Use the OpenAI local app quick start if you want the browser UI with OpenAI models.
3. Use the local Qwen quick start if you want the browser UI with local Ollama models.
## MCP Quick Install
@@ -44,17 +44,35 @@ Run `doctor` after setup or whenever MCP feels stale:
npx -y ra-h-mcp-server@latest doctor
```
## Local App Quick Start
## Local App Quick Start: OpenAI
```bash
git clone https://github.com/bradwmorris/ra-h_os.git
cd ra-h_os
npm install
npm run setup:local
npm run setup:local -- --profile openai
npm run dev
```
Open http://localhost:3000
Open http://localhost:3000 and add your OpenAI API key when prompted, or later in Settings -> API Keys.
## Local App Quick Start: Local Qwen
Requires Ollama to be installed and running.
```bash
git clone https://github.com/bradwmorris/ra-h_os.git
cd ra-h_os
npm install
ollama pull qwen3:4b
ollama pull qwen3-embedding:0.6b
npm run setup:local -- --profile qwen-local
npm run dev
```
Open http://localhost:3000. Settings -> API Keys shows the active local model profile and disables OpenAI key entry.
Fresh app setup must choose `--profile openai` or `--profile qwen-local` before vector tables are created. OpenAI embeddings use width `1536`; the supported Qwen embedding profile uses width `1024`.
## MCP Integration
@@ -73,7 +91,7 @@ The recommended MCP setup is the CLI command above. Manual config is only for tr
If you need a frozen version for release/debug work, pin it intentionally and restart the client.
The setup command creates the default database if it does not exist. The standalone MCP server can write nodes without the app running, but the app owns chunking and embedding from node source: readable `chunks`, full-text indexes, `vec_nodes`, and `vec_chunks`. See [MCP docs](./8_mcp.md) for the full install, verify, memory-file, and troubleshooting path.
The selected setup profile creates the default database if it does not exist. The standalone MCP server can write nodes without the app running, but the app owns chunking and embedding from node source: readable `chunks`, full-text indexes, `vec_nodes`, and `vec_chunks`. See [MCP docs](./8_mcp.md) for the full install, verify, memory-file, and troubleshooting path.
## Questions?