updates to install procedures
This commit is contained in:
79
INSTALL.md
79
INSTALL.md
@@ -331,45 +331,38 @@ obsidian-rag index
|
||||
|
||||
## 8. Register the Plugin with OpenClaw
|
||||
|
||||
OpenClaw auto-discovers plugins by reading the `openclaw.plugin.json` manifest in the project root and loading `dist/index.js`.
|
||||
OpenClaw discovers plugins from these locations:
|
||||
- `~/.openclaw/extensions/` (global, recommended for most users)
|
||||
- `<workspace>/.openclaw/extensions/` (workspace-specific)
|
||||
- Bundled plugins in OpenClaw's install directory
|
||||
|
||||
### 8.1 Register via OpenClaw's Plugin Manager
|
||||
### 8.1 Link Plugin to Global Extensions (Recommended)
|
||||
|
||||
```bash
|
||||
# OpenClaw CLI — register the local plugin
|
||||
openclaw plugin add "$DESTINATION"
|
||||
# or, if OpenClaw has a specific register command:
|
||||
openclaw plugins register --path "$DESTINATION/dist/index.js" --name obsidian-rag
|
||||
mkdir -p ~/.openclaw/extensions
|
||||
ln -s "$DESTINATION" ~/.openclaw/extensions/obsidian-rag
|
||||
```
|
||||
|
||||
> **Note:** The exact command depends on your OpenClaw version. Check `openclaw --help` or `openclaw plugin --help` for the correct syntax. The plugin manifest (`openclaw.plugin.json`) in this project already declares all four tools.
|
||||
|
||||
### 8.2 Alternative — Register by Path in OpenClaw Config
|
||||
|
||||
If your OpenClaw installation uses a config file (e.g., `~/.openclaw/config.json` or `~/.openclaw/plugins.json`), add this project's built bundle:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{
|
||||
"name": "obsidian-rag",
|
||||
"path": "/full/path/to/obsidian-rag/dist/index.js"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 8.3 Confirm the Plugin Loaded
|
||||
### 8.2 Link Plugin to Workspace Extensions (Alternative)
|
||||
|
||||
```bash
|
||||
openclaw plugins list
|
||||
# → obsidian-rag 0.1.0 (loaded)
|
||||
# From your OpenClaw workspace root
|
||||
mkdir -p ./.openclaw/extensions
|
||||
ln -s "$DESTINATION" ./.openclaw/extensions/obsidian-rag
|
||||
```
|
||||
|
||||
Or, if OpenClaw has a status command:
|
||||
### 8.3 Using openclaw plugins install --link
|
||||
|
||||
```bash
|
||||
openclaw status
|
||||
# → Plugin: obsidian-rag ✓ loaded
|
||||
openclaw plugins install --link "$DESTINATION"
|
||||
```
|
||||
|
||||
### 8.4 Confirm the Plugin Loaded
|
||||
|
||||
```bash
|
||||
openclaw plugins list | grep obsidian-rag
|
||||
# or
|
||||
openclaw plugins list --verbose | grep obsidian-rag
|
||||
```
|
||||
|
||||
---
|
||||
@@ -589,10 +582,27 @@ Use an absolute path with proper escaping:
|
||||
|
||||
### Plugin not appearing in `openclaw plugins list`
|
||||
|
||||
1. Confirm `dist/index.js` exists (`ls -la dist/`)
|
||||
2. Check that `openclaw.plugin.json` is valid JSON
|
||||
3. Try re-registering: `openclaw plugin add "$DESTINATION"`
|
||||
4. Check OpenClaw's plugin discovery path — it may need to be in a specific directory like `~/.openclaw/plugins/`
|
||||
1. Confirm `dist/index.js` exists:
|
||||
```bash
|
||||
ls -la ~/.openclaw/extensions/obsidian-rag/dist/
|
||||
```
|
||||
2. Confirm `openclaw.plugin.json` exists:
|
||||
```bash
|
||||
ls ~/.openclaw/extensions/obsidian-rag/openclaw.plugin.json
|
||||
```
|
||||
3. Check that the symlink is valid (not broken):
|
||||
```bash
|
||||
ls -la ~/.openclaw/extensions/obsidian-rag
|
||||
# Should point to your DESTINATION, not show as "red" (broken)
|
||||
```
|
||||
4. Verify the manifest has `configSchema` (required since v0.1.1):
|
||||
```bash
|
||||
grep configSchema ~/.openclaw/extensions/obsidian-rag/openclaw.plugin.json
|
||||
```
|
||||
5. Try bypassing discovery cache:
|
||||
```bash
|
||||
OPENCLAW_DISABLE_PLUGIN_DISCOVERY_CACHE=1 openclaw plugins list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -623,7 +633,8 @@ npm run build
|
||||
obsidian-rag index
|
||||
|
||||
# 7. Register with OpenClaw
|
||||
openclaw plugin add ~/dev/obsidian-rag
|
||||
mkdir -p ~/.openclaw/extensions
|
||||
ln -s ~/dev/obsidian-rag ~/.openclaw/extensions/obsidian-rag
|
||||
|
||||
# 8. Verify
|
||||
obsidian-rag status
|
||||
|
||||
Reference in New Issue
Block a user