@usecortex_ai/openclaw-cortex-ai 0.1.2 → 0.1.4

package/README.md

@@ -10,16 +10,65 @@ openclaw plugins install @usecortex_ai/openclaw-cortex-ai
 
 Restart OpenClaw after installing.
 
-## Configuration
+If you run OpenClaw via the local gateway, restart it too:
 
-Two required values: your Cortex API key and tenant ID.
+```bash
+openclaw gateway restart
+```
+
+## Get Your Credentials
+1. Get your Cortex API Key from [Cortex AI](https://app.usecortex.ai)
+2. Get your Tenant ID from the Cortex dashboard
+
+## Interactive Onboarding
+
+Run the interactive CLI wizard (recommended):
+
+```bash
+# Basic onboarding (API key, tenant ID, sub-tenant, ignore term)
+openclaw cortex onboard
+
+# Advanced onboarding (all options including recall mode, graph context, etc.)
+openclaw cortex onboard --advanced
+```
+
+The wizard guides you through configuration with colored prompts and **writes your config to** `plugins.entries.openclaw-cortex-ai.config` inside OpenClaw's settings file.
+
+The path is resolved in the same order OpenClaw itself uses:
+
+1. `$OPENCLAW_CONFIG_PATH` — if set, used directly
+2. `$OPENCLAW_STATE_DIR/openclaw.json` — if `OPENCLAW_STATE_DIR` is set
+3. `$OPENCLAW_HOME/.openclaw/openclaw.json` — if `OPENCLAW_HOME` is set
+4. Default: `~/.openclaw/openclaw.json` (macOS/Linux) or `%USERPROFILE%\.openclaw\openclaw.json` (Windows)
+
+No manual adjustment needed — the wizard auto-detects the correct path.
+
+After onboarding, restart the gateway:
+
+```bash
+openclaw gateway restart
+```
+
+## Manual Configuration
+
+If you prefer, you can configure credentials manually.
+
+Two required values:
+
+- **API key**
+- **Tenant ID**
+
+Environment variables (recommended for secrets):
 
 ```bash
 export CORTEX_OPENCLAW_API_KEY="your-api-key"
 export CORTEX_OPENCLAW_TENANT_ID="your-tenant-id"
 ```
 
-Or configure directly in `openclaw.json`:
+Or configure directly in OpenClaw's settings file:
+
+- **macOS / Linux:** `~/.openclaw/openclaw.json`
+- **Windows:** `%USERPROFILE%\.openclaw\openclaw.json`
 
 ```json5
 {
@@ -37,11 +86,17 @@ Or configure directly in `openclaw.json`:
 }
 ```
 
+After changing config, restart the gateway so the plugin reloads:
+
+```bash
+openclaw gateway restart
+```
+
 ### Options
 
 | Key                  | Type        | Default               | Description                                                                    |
 | -------------------- | ----------- | --------------------- | ------------------------------------------------------------------------------ |
-| `subTenantId`      | `string`  | `"cortex-openclaw"` | Sub-tenant for data partitioning within your tenant                            |
+| `subTenantId`      | `string`  | `"cortex-openclaw-plugin"` | Sub-tenant for data partitioning within your tenant                      |
 | `autoRecall`       | `boolean` | `true`              | Inject relevant memories before every AI turn                                  |
 | `autoCapture`      | `boolean` | `true`              | Store conversation exchanges after every AI turn                               |
 | `maxRecallResults` | `number`  | `10`                | Max memory chunks injected into context per turn                               |
@@ -55,23 +110,6 @@ Or configure directly in `openclaw.json`:
 - **Auto-Recall** — Before every AI turn, queries Cortex (`/recall/recall_preferences`) for relevant memories and injects graph-enriched context (entity paths, chunk relations, extra context).
 - **Auto-Capture** — After every AI turn, the last user/assistant exchange is sent to Cortex (`/memories/add_memory`) as conversation pairs with `infer: true` and `upsert: true`. The session ID is used as `source_id` so Cortex groups exchanges per session and builds a knowledge graph automatically.
 
-## Interactive Onboarding
-
-Run the interactive CLI wizard to configure Cortex AI:
-
-```bash
-# Basic onboarding (API key, tenant ID, sub-tenant, ignore term)
-openclaw cortex onboard
-
-# Advanced onboarding (all options including recall mode, graph context, etc.)
-openclaw cortex onboard --advanced
-```
-
-The wizard guides you through configuration with colored prompts, validates inputs, and outputs:
-- `.env` file lines for credentials
-- Plugin config JSON for non-default settings
-- A summary table with masked sensitive values
-
 ## Slash Commands
 
 | Command                     | Description                           |
@@ -85,10 +123,13 @@ The wizard guides you through configuration with colored prompts, validates inpu
 
 ## AI Tools
 
-| Tool              | Description                                 |
-| ----------------- | ------------------------------------------- |
-| `cortex_store`  | Save information to memory                  |
-| `cortex_search` | Search memories with graph-enriched results |
+| Tool                   | Description |
+| ---------------------- | ----------- |
+| `cortex_store`         | Save the recent conversation history to Cortex as memory |
+| `cortex_search`        | Search Cortex memories (returns graph-enriched context) |
+| `cortex_list_memories` | List all stored user memories (IDs + summaries) |
+| `cortex_get_content`   | Fetch full content for a specific `source_id` |
+| `cortex_delete_memory` | Delete a memory by `memory_id` (use only when user explicitly asks) |
 
 ## CLI
 
@@ -102,6 +143,27 @@ openclaw cortex get <source_id>     # Fetch source content
 openclaw cortex status              # Show plugin configuration
 ```
 
+## Troubleshooting
+
+### `Not configured. Run openclaw cortex onboard`
+
+This means the plugin is enabled, but credentials are missing.
+
+Run:
+
+```bash
+openclaw cortex onboard
+openclaw gateway restart
+```
+
+### CLI says a command is unknown
+
+Update/restart the gateway so it reloads the plugin:
+
+```bash
+openclaw gateway restart
+```
+
 ## Context Injection
 
 Recalled context is injected inside `<cortex-context>` tags containing:

package/commands/onboarding.ts

@@ -1,4 +1,5 @@
 import * as fs from "node:fs"
+import * as os from "node:os"
 import * as path from "node:path"
 import * as readline from "node:readline"
 import type { OpenClawPluginApi } from "openclaw/plugin-sdk"
@@ -209,13 +210,27 @@ function buildConfigObj(result: WizardResult): Record<string, unknown> {
 	return obj
 }
 
-// ── Persist to ~/.openclaw/openclaw.json ──
+// ── Persist to openclaw.json ──
+// Mirrors openclaw's own path resolution (src/config/paths.ts):
+//   1. $OPENCLAW_CONFIG_PATH  (explicit override)
+//   2. $OPENCLAW_STATE_DIR/openclaw.json
+//   3. $OPENCLAW_HOME/.openclaw/openclaw.json
+//   4. os.homedir()/.openclaw/openclaw.json  (default)
 
-const OPENCLAW_CONFIG_PATH = path.join(
-	process.env.HOME ?? process.env.USERPROFILE ?? "~",
-	".openclaw",
-	"openclaw.json",
-)
+function resolveOpenClawConfigPath(): string {
+	if (process.env.OPENCLAW_CONFIG_PATH) {
+		return process.env.OPENCLAW_CONFIG_PATH
+	}
+	if (process.env.OPENCLAW_STATE_DIR) {
+		return path.join(process.env.OPENCLAW_STATE_DIR, "openclaw.json")
+	}
+	if (process.env.OPENCLAW_HOME) {
+		return path.join(process.env.OPENCLAW_HOME, ".openclaw", "openclaw.json")
+	}
+	return path.join(os.homedir(), ".openclaw", "openclaw.json")
+}
+
+const OPENCLAW_CONFIG_PATH = resolveOpenClawConfigPath()
 
 function persistConfig(configObj: Record<string, unknown>): boolean {
 	try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usecortex_ai/openclaw-cortex-ai",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "type": "module",
   "description": "OpenClaw plugin for Cortex AI — the State-of-the-art agentic memory system with auto-capture, recall, and knowledge graph context for open-claw",
   "license": "MIT",