Skip to content

Commit 6d9bcb6

Browse files
anthonylee991claude
andcommitted
v0.4.1: New icon, simplified docs, DEVELOPER.md, version bump
- Replace app icon with new lowercase "o" design - Rewrite AI_SETUP.md and API_REFERENCE.md as relay-only (no CLI/localhost) - Create DEVELOPER.md for advanced users (CLI, tunnels, local API, MCP stdio/SSE) - Add DEVELOPER.md to GitHub Actions build workflow - Clarify SSE relay is for browser-based MCP clients only - Fix README misleading text about n8n/Make.com standalone usage - Bump version to 0.4.1 across all configs and source Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5fd92b7 commit 6d9bcb6

76 files changed

Lines changed: 1469 additions & 299 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ jobs:
165165
cp docs/AI_SETUP.md "${DIST}/documentation/" 2>/dev/null || true
166166
cp docs/OVERVIEW.md "${DIST}/documentation/" 2>/dev/null || true
167167
cp docs/LICENSE "${DIST}/documentation/" 2>/dev/null || true
168+
cp docs/DEVELOPER.md "${DIST}/documentation/" 2>/dev/null || true
168169
cp docs/THIRD_PARTY_NOTICES.md "${DIST}/documentation/" 2>/dev/null || true
169170
170171
# Zip
@@ -196,7 +197,7 @@ jobs:
196197
197198
# Documentation
198199
Copy-Item "README-WINDOWS.md" "$DIST\README.md"
199-
$docs = @("docs\CLI.md", "docs\MCP.md", "docs\API_REFERENCE.md", "docs\AI_SETUP.md", "docs\OVERVIEW.md", "docs\LICENSE", "docs\THIRD_PARTY_NOTICES.md")
200+
$docs = @("docs\CLI.md", "docs\MCP.md", "docs\API_REFERENCE.md", "docs\AI_SETUP.md", "docs\OVERVIEW.md", "docs\DEVELOPER.md", "docs\LICENSE", "docs\THIRD_PARTY_NOTICES.md")
200201
foreach ($doc in $docs) {
201202
if (Test-Path $doc) { Copy-Item $doc "$DIST\documentation\" }
202203
}
@@ -215,6 +216,6 @@ jobs:
215216
TAG="${{ github.ref_name }}"
216217
# workflow_dispatch may not have a tag, use a default
217218
if [ -z "$TAG" ] || [ "$TAG" = "" ]; then
218-
TAG="v0.3.4"
219+
TAG="v0.4.1"
219220
fi
220221
gh release upload "$TAG" "${{ matrix.dist_name }}.zip" --clobber

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "orunla"
3-
version = "0.3.4"
3+
version = "0.4.1"
44
edition = "2021"
55

66
[dependencies]

README-MAC.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## What's Included
99

1010
```
11-
Orunla_macOS_v0.3.4/
11+
Orunla_macOS_v0.4.1/
1212
├── orunla-mac-aarch64/ ← Apple Silicon (M1/M2/M3/M4)
1313
└── orunla-mac-x86_64/ ← Intel Macs
1414
@@ -47,10 +47,10 @@ Open Terminal and navigate to the correct folder for your Mac:
4747

4848
```bash
4949
# Apple Silicon (M1/M2/M3/M4):
50-
cd /path/to/Orunla_macOS_v0.3.4/orunla-mac-aarch64
50+
cd /path/to/Orunla_macOS_v0.4.1/orunla-mac-aarch64
5151

5252
# Intel Mac:
53-
cd /path/to/Orunla_macOS_v0.3.4/orunla-mac-x86_64
53+
cd /path/to/Orunla_macOS_v0.4.1/orunla-mac-x86_64
5454
```
5555

5656
Replace `/path/to/` with wherever you extracted the bundle (e.g., `~/Downloads/`).
@@ -78,11 +78,11 @@ To make this permanent, add it to your shell profile (adjust path for your setup
7878

7979
```bash
8080
# For zsh (default on macOS) — Apple Silicon example:
81-
echo 'export ORT_DYLIB_PATH="$HOME/Orunla_macOS_v0.3.4/orunla-mac-aarch64/libonnxruntime.dylib"' >> ~/.zshrc
81+
echo 'export ORT_DYLIB_PATH="$HOME/Orunla_macOS_v0.4.1/orunla-mac-aarch64/libonnxruntime.dylib"' >> ~/.zshrc
8282
source ~/.zshrc
8383

8484
# For bash:
85-
echo 'export ORT_DYLIB_PATH="$HOME/Orunla_macOS_v0.3.4/orunla-mac-aarch64/libonnxruntime.dylib"' >> ~/.bash_profile
85+
echo 'export ORT_DYLIB_PATH="$HOME/Orunla_macOS_v0.4.1/orunla-mac-aarch64/libonnxruntime.dylib"' >> ~/.bash_profile
8686
source ~/.bash_profile
8787
```
8888

@@ -146,7 +146,7 @@ Run commands from inside your platform folder:
146146

147147
### Option 3: REST API Server
148148

149-
Start the server for webhooks, n8n, Make.com, or custom integrations:
149+
Start the server for local integrations, scripting, or headless use:
150150

151151
```bash
152152
./orunla_cli serve --port 3000
@@ -160,9 +160,34 @@ To secure the API when exposing to a network:
160160

161161
See `documentation/API_REFERENCE.md` for all endpoints.
162162

163+
#### API Key (v0.4.0)
164+
165+
When using the REST API server, you can secure it with an API key. When set, all REST API requests require the key via one of:
166+
167+
- `X-API-Key: your-key` header
168+
- `Authorization: Bearer your-key` header
169+
170+
**MCP is not affected** — the API key only applies to REST API endpoints. Stdio MCP and SSE MCP connections are not gated by the API key.
171+
172+
To set the API key:
173+
1. Pass it on the command line: `./orunla_cli serve --port 3000 --api-key "your-key"`, **or**
174+
2. Manually edit `~/.orunla/config.json` and add `"api_key": "your-key"`
175+
176+
Requires a server restart to take effect.
177+
178+
#### Cloud REST API Relay (v0.4.0 — Windows/Tauri Desktop App)
179+
180+
If you use the Windows desktop app (Orunla.exe), it provides a **cloud REST API relay URL** shown in the "Remote Access" card. External services (ChatGPT Custom GPTs, n8n, Make.com) can use this URL to access your Orunla REST API without setting up tunnels or port forwarding.
181+
182+
- The relay URL works whenever the desktop app is open
183+
- If an API key is set, remote requests must include it
184+
- **File upload** (`/ingest-file`) is not supported via the relay — use the local API for file ingestion
185+
186+
> **Stdio MCP does not require the desktop app.** The standalone `orunla_mcp` binary works independently — you only need the REST API server (via `orunla_cli serve`) or the desktop app for REST/relay features.
187+
163188
### Option 4: MCP Integration (Claude Desktop / Cursor / Cline)
164189

165-
The MCP server gives AI assistants direct access to your memory graph.
190+
The MCP server gives AI assistants direct access to your memory graph. This works **independently of the desktop app** — you don't need a server running.
166191

167192
**Important:** All paths in MCP configs must be absolute. Replace the example paths below with the actual location of your Orunla folder.
168193

@@ -178,9 +203,9 @@ The MCP server gives AI assistants direct access to your memory graph.
178203
{
179204
"mcpServers": {
180205
"orunla": {
181-
"command": "/Users/YourUsername/Orunla_macOS_v0.3.4/orunla-mac-aarch64/orunla_mcp",
206+
"command": "/Users/YourUsername/Orunla_macOS_v0.4.1/orunla-mac-aarch64/orunla_mcp",
182207
"env": {
183-
"ORT_DYLIB_PATH": "/Users/YourUsername/Orunla_macOS_v0.3.4/orunla-mac-aarch64/libonnxruntime.dylib"
208+
"ORT_DYLIB_PATH": "/Users/YourUsername/Orunla_macOS_v0.4.1/orunla-mac-aarch64/libonnxruntime.dylib"
184209
}
185210
}
186211
}
@@ -199,9 +224,9 @@ Add to `~/.claude/settings.json` or your project's `.claude/settings.json`:
199224
{
200225
"mcpServers": {
201226
"orunla": {
202-
"command": "/Users/YourUsername/Orunla_macOS_v0.3.4/orunla-mac-aarch64/orunla_mcp",
227+
"command": "/Users/YourUsername/Orunla_macOS_v0.4.1/orunla-mac-aarch64/orunla_mcp",
203228
"env": {
204-
"ORT_DYLIB_PATH": "/Users/YourUsername/Orunla_macOS_v0.3.4/orunla-mac-aarch64/libonnxruntime.dylib"
229+
"ORT_DYLIB_PATH": "/Users/YourUsername/Orunla_macOS_v0.4.1/orunla-mac-aarch64/libonnxruntime.dylib"
205230
}
206231
}
207232
}
@@ -286,7 +311,7 @@ This SQLite database contains:
286311

287312
Run the quarantine removal from Step 2:
288313
```bash
289-
cd /path/to/Orunla_macOS_v0.3.4/orunla-mac-aarch64
314+
cd /path/to/Orunla_macOS_v0.4.1/orunla-mac-aarch64
290315
xattr -cr .
291316
chmod +x orunla_cli orunla_mcp launch_orunla.sh
292317
```

0 commit comments

Comments
 (0)