Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 0 additions & 205 deletions INSTALL.md

This file was deleted.

12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ No HTTP server. Matches the plugin’s **default** (`mode: cli`).
pip install powermem
```

2. **Config** — Use [INSTALL.md](INSTALL.md) one-liner `install.sh` to create `~/.openclaw/powermem/powermem.env` (SQLite template), or copy from PowerMem’s `.env.example`. Set `LLM_*` and `EMBEDDING_*`.
2. **Config** — From a clone of this repo, run `bash install.sh` (or the curl one-liner under **Install options** below) to create an optional `~/.openclaw/powermem/powermem.env` template, or copy from PowerMem’s `.env.example`. Set `LLM_*` and `EMBEDDING_*` when not relying on OpenClaw-injected models.

3. If `pmem` exists only inside the venv, set `pmemPath` in the plugin `config` to the absolute path of `pmem` in that venv.

Expand Down Expand Up @@ -157,9 +157,13 @@ JSON response means the server is up. API docs: `http://localhost:8000/docs`.

## Install options

- **One-click (Linux/macOS):** See [INSTALL.md](INSTALL.md) for `install.sh` (curl or run from repo root).
- **OpenClaw skill (minimal install):** Copy [skills/install-powermem-memory-minimal/SKILL.md](skills/install-powermem-memory-minimal/SKILL.md) to `~/.openclaw/skills/install-powermem-memory-minimal/`, then say **「PowerMem 快速安装」** / **“PowerMem quickstart”** or **“Minimal install memory-powermem”** / **“Install powermem memory minimal”**.
- **OpenClaw skill (full guide):** Copy [skills/install-powermem-memory/SKILL.md](skills/install-powermem-memory/SKILL.md) (and its sibling `.md` files in that folder if you mirror the repo) to `~/.openclaw/skills/install-powermem-memory/`, then say **「安装 PowerMem 记忆」** / **“Install PowerMem memory”**. The minimal and full skills are **independent**; use whichever fits your workflow.
- **One-click (Linux/macOS):**
```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash
```
From a clone: `cd /path/to/memory-powermem && bash install.sh`. Non-interactive: same URL but pipe to `bash -s -y`. Another OpenClaw instance: `bash -s -- --workdir ~/.openclaw-second`. Details and troubleshooting: OpenClaw skill **`install-memory-powermem-full`** ([skills/install-memory-powermem-full/](skills/install-memory-powermem-full/)).
- **OpenClaw skill — quickstart (`install-memory-powermem`):** Copy [skills/install-memory-powermem/SKILL.md](skills/install-memory-powermem/SKILL.md) to `~/.openclaw/skills/install-memory-powermem/`, then say **「PowerMem 快速安装」** / **“PowerMem quickstart”** or **“Minimal install memory-powermem”** / **“Install memory powermem minimal”**.
- **OpenClaw skill — full guide (`install-memory-powermem-full`):** Copy [skills/install-memory-powermem-full/SKILL.md](skills/install-memory-powermem-full/SKILL.md) (and its sibling `.md` files in that folder if you mirror the repo) to `~/.openclaw/skills/install-memory-powermem-full/`, then say **「安装 PowerMem 记忆」** / **“Install PowerMem memory”**. The quickstart and full-guide skills are **independent**; use whichever fits your workflow.
- **Manual:** Steps below.

---
Expand Down
12 changes: 8 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
pip install powermem
```

2. 配置:用 [INSTALL.md](INSTALL.md) 里的一键 `install.sh` 生成 `~/.openclaw/powermem/powermem.env`(SQLite 模板),或复制 PowerMem 官方 `.env.example`,填写 `LLM_*`、`EMBEDDING_*`。
2. 配置:克隆本仓库后在根目录执行 `bash install.sh`(或使用下方「安装方式」里的 curl 一键命令)可生成可选的 `~/.openclaw/powermem/powermem.env` 模板;也可复制 PowerMem 官方 `.env.example` 并填写 `LLM_*`、`EMBEDDING_*`(不依赖 OpenClaw 注入模型时需要)

3. 若 `pmem` 只在 venv 里,在插件 `config` 里把 `pmemPath` 设为该 venv 下 `pmem` 的绝对路径。

Expand Down Expand Up @@ -158,9 +158,13 @@ curl -s http://localhost:8000/api/v1/system/health

## 安装方式

- **一键安装(Linux/macOS):** 见 [INSTALL.md](INSTALL.md),使用 `install.sh`(curl 或从仓库根目录执行)。
- **OpenClaw skill(最小安装):** 将 [skills/install-powermem-memory-minimal/SKILL.md](skills/install-powermem-memory-minimal/SKILL.md) 复制到 `~/.openclaw/skills/install-powermem-memory-minimal/`,然后说「**PowerMem 快速安装**」或「**memory-powermem 最小安装**」或 **“Install powermem memory minimal”**。
- **OpenClaw skill(完整指南):** 将 [skills/install-powermem-memory/SKILL.md](skills/install-powermem-memory/SKILL.md)(若从仓库拷贝,建议连同该目录下其余 `.md` 一并放入 skill 目录)复制到 `~/.openclaw/skills/install-powermem-memory/`,然后说「**安装 PowerMem 记忆**」。最小安装与完整指南两个 skill **彼此独立**,按需选用其一即可。
- **一键安装(Linux/macOS):**
```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash
```
已克隆仓库:`cd /path/to/memory-powermem && bash install.sh`。非交互:同一 curl 命令改为接到 `bash -s -y`。指定另一数据目录:`bash -s -- --workdir ~/.openclaw-second`。更完整的说明与排错见 OpenClaw skill **`install-memory-powermem-full`**([skills/install-memory-powermem-full/](skills/install-memory-powermem-full/))。
- **OpenClaw skill — 快速安装(`install-memory-powermem`):** 将 [skills/install-memory-powermem/SKILL.md](skills/install-memory-powermem/SKILL.md) 复制到 `~/.openclaw/skills/install-memory-powermem/`,然后说「**PowerMem 快速安装**」或「**memory-powermem 最小安装**」或 **“Install memory powermem minimal”**。
- **OpenClaw skill — 完整指南(`install-memory-powermem-full`):** 将 [skills/install-memory-powermem-full/SKILL.md](skills/install-memory-powermem-full/SKILL.md)(若从仓库拷贝,建议连同该目录下其余 `.md` 一并放入 skill 目录)复制到 `~/.openclaw/skills/install-memory-powermem-full/`,然后说「**安装 PowerMem 记忆**」。快速安装与完整指南两个 skill **彼此独立**,按需选用其一即可。
- **手动安装:** 按下面步骤操作。

---
Expand Down
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ case "$(uname -s)" in
*) OS="unknown";;
esac
if [[ "$OS" == "windows" ]]; then
err "Windows is not supported by this script. Use manual install (see INSTALL.md)."
err "Windows is not supported by this script. Use README.md or skills/install-memory-powermem-full for manual steps."
exit 1
fi

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: install-powermem-memory
description: Step-by-step guide to install and configure the PowerMem long-term memory plugin (full path, options, troubleshooting). After setup, the plugin auto-captures conversation highlights and auto-recalls relevant memories. This skill is self-contained and can be published independently of any minimal-install skill.
name: install-memory-powermem-full
description: OpenClaw full guide skill (id and folder name install-memory-powermem-full). Step-by-step install and configuration for the PowerMem long-term memory pluginoptions, tools, troubleshooting—and bundled reference docs. Complements the quickstart skill install-memory-powermem; either can be used alone.
triggers:
- "安装 PowerMem 记忆"
- "安装 PowerMem 记忆插件"
Expand All @@ -13,7 +13,9 @@ triggers:
- "What is PowerMem"
---

# PowerMem Memory Guide
# PowerMem Memory — Full Guide

**Skill id / OpenClaw folder name:** `install-memory-powermem-full`. For the shortest install-only path, use **`install-memory-powermem`** (quickstart).

This skill folder includes supplementary docs:

Expand Down Expand Up @@ -55,11 +57,11 @@ The curl **`install.sh`** deploys the plugin and OpenClaw entries; with **`-y`**
- Check: `curl -s http://localhost:8000/api/v1/system/health`.

5. **Install the plugin**
`openclaw plugins install /path/to/memory-powermem`, or **`install.sh`** from [INSTALL.md](https://github.com/ob-labs/memory-powermem/blob/main/INSTALL.md).
`openclaw plugins install /path/to/memory-powermem` (or `openclaw plugins install memory-powermem` from npm), or run **`install.sh`** from the [memory-powermem](https://github.com/ob-labs/memory-powermem) repo — see **One-click plugin deploy (`install.sh`)** below for curl / flags / `--workdir`.

6. **Configure OpenClaw**

**CLI — minimal (recommended, matches plugin defaults):**
**CLI — defaults (recommended, matches plugin defaults):**
Do **not** set `envFile` unless you need a file. Example:

```bash
Expand Down Expand Up @@ -105,6 +107,84 @@ The curl **`install.sh`** deploys the plugin and OpenClaw entries; with **`-y`**
openclaw ltm search "coffee"
```

## One-click plugin deploy (`install.sh`)

**Requires:** OpenClaw installed (`openclaw --version`). The script does **not** run `pip install powermem`; ensure **`pmem`** is on PATH when the gateway runs or set **`pmemPath`**.

**Default:** configures plugin **CLI** mode. With **`-y`**, it may still create **`~/.openclaw/powermem/powermem.env`** as an optional template — not required if you use OpenClaw-injected LLM + default SQLite.

```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash
```

From a local clone (no download):

```bash
cd /path/to/memory-powermem && bash install.sh
```

Non-interactive (defaults: CLI, may seed env file):

```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash -s -y
```

Target a different OpenClaw instance:

```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash -s -- --workdir ~/.openclaw-second
```

**What the script does:** resolve OpenClaw workdir → choose or default **cli** / **http** and paths → for CLI, optionally seed `powermem.env` if missing → deploy plugin to `<workdir>/extensions/memory-powermem` → `npm install` there → set OpenClaw config (`plugins.enabled`, `slots.memory`, `entries.memory-powermem`).

**After (CLI):** `openclaw gateway`, then `openclaw ltm health` — you usually **do not** need to edit `powermem.env` when using plugin defaults.

**After (HTTP):** start PowerMem with a proper `.env` in the server cwd, then start the gateway.

## Copy a skill into OpenClaw

Copy **one** skill you want into `~/.openclaw/skills/<skill-name>/` (folder name should match the skill id). The quickstart and full-guide skills are **independent**.

**Quickstart (`install-memory-powermem`) — Linux / macOS:**

```bash
mkdir -p ~/.openclaw/skills/install-memory-powermem
cp /path/to/memory-powermem/skills/install-memory-powermem/SKILL.md \
~/.openclaw/skills/install-memory-powermem/
```

**Full guide (`install-memory-powermem-full`) — Linux / macOS:** copy **all** `.md` files in that folder.

```bash
mkdir -p ~/.openclaw/skills/install-memory-powermem-full
cp /path/to/memory-powermem/skills/install-memory-powermem-full/*.md \
~/.openclaw/skills/install-memory-powermem-full/
```

**Full guide — Windows (PowerShell):**

```powershell
New-Item -ItemType Directory -Force "$env:USERPROFILE\.openclaw\skills\install-memory-powermem-full"
Copy-Item "path\to\memory-powermem\skills\install-memory-powermem-full\*.md" `
"$env:USERPROFILE\.openclaw\skills\install-memory-powermem-full\"
```

## Multi-instance OpenClaw (`--workdir` / `OPENCLAW_STATE_DIR`)

**Install script:**

```bash
curl -fsSL https://raw.githubusercontent.com/ob-labs/memory-powermem/main/install.sh | bash -s -- --workdir ~/.openclaw-second
```

**Manual config** for that instance:

```bash
OPENCLAW_STATE_DIR=~/.openclaw-second openclaw config set plugins.slots.memory memory-powermem
```

Plugin data and default SQLite follow **that** instance’s `stateDir`.

## Available Tools

| Tool | Description |
Expand Down Expand Up @@ -154,3 +234,4 @@ Restart the gateway after slot or plugin config changes.
| **Wrong SQLite file / instance** | Data is under **that OpenClaw instance’s `stateDir`** (`OPENCLAW_STATE_DIR` / `--workdir`). |
| **HTTP mode** | Server running, **`baseUrl`** correct, **`apiKey`** if enabled. |
| **`openclaw plugins list`**: no `memory-powermem`, or status is not **loaded** | Re-run plugin install; set `plugins.enabled` true and `plugins.slots.memory` = `memory-powermem`; restart **gateway**; run `openclaw plugins list` again until **memory-powermem** shows **loaded**. |
| **Add/search returns 500 or empty** | Check PowerMem / gateway logs; often missing or mismatched **`LLM_*` / `EMBEDDING_*`** in **`envFile`** when **`useOpenClawModel`** is false or overrides are incomplete. |
Loading
Loading