Skip to content

Commit c405bf8

Browse files
Thomas Tupperclaude
authored andcommitted
chore: publish to npm on push to main, update install docs
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent cfcc3e2 commit c405bf8

2 files changed

Lines changed: 71 additions & 16 deletions

File tree

.github/workflows/publish.yml

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
name: Publish to GitHub Packages
1+
name: Publish to npm
22

33
on:
44
push:
5-
tags:
6-
- "v*"
5+
branches:
6+
- main
77

88
jobs:
99
publish:
1010
name: Build and publish
1111
runs-on: ubuntu-latest
1212
permissions:
1313
contents: read
14-
packages: write
1514

1615
steps:
1716
- uses: actions/checkout@v4
@@ -20,21 +19,15 @@ jobs:
2019
uses: actions/setup-node@v4
2120
with:
2221
node-version: "20"
23-
registry-url: "https://npm.pkg.github.com"
24-
scope: "@foxlight-foundation"
22+
registry-url: "https://registry.npmjs.org"
2523

2624
- name: Install dependencies
2725
run: yarn install --frozen-lockfile
2826

2927
- name: Build
3028
run: yarn build
3129

32-
- name: Set package version from tag
33-
run: |
34-
TAG="${GITHUB_REF_NAME#v}"
35-
npm version "$TAG" --no-git-tag-version
36-
3730
- name: Publish
3831
run: yarn publish --access public --non-interactive
3932
env:
40-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 66 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,68 @@ This is the v2 successor to `foxmemory-openclaw-memory`. The primary change is t
66

77
---
88

9+
## Installation
10+
11+
```bash
12+
openclaw plugins install @foxlight-foundation/foxmemory-plugin-v2
13+
```
14+
15+
Pin to an exact version (recommended for production):
16+
17+
```bash
18+
openclaw plugins install @foxlight-foundation/foxmemory-plugin-v2 --pin
19+
```
20+
21+
---
22+
23+
## Configuration
24+
25+
### FoxMemory backend (recommended)
26+
27+
Point the plugin at your self-hosted `foxmemory-store` instance:
28+
29+
```json
30+
{
31+
"baseUrl": "http://your-foxmemory-host:8082",
32+
"userId": "your-user-id",
33+
"autoCapture": true,
34+
"autoRecall": true
35+
}
36+
```
37+
38+
### Mem0 platform (cloud)
39+
40+
Use Mem0's managed cloud platform instead:
41+
42+
```json
43+
{
44+
"mode": "platform",
45+
"apiKey": "${MEM0_API_KEY}",
46+
"userId": "your-user-id"
47+
}
48+
```
49+
50+
`${MEM0_API_KEY}` will be resolved from the environment variable of that name if set.
51+
52+
### Mem0 open-source (self-hosted SDK)
53+
54+
Run Mem0 OSS directly without `foxmemory-store`:
55+
56+
```json
57+
{
58+
"mode": "open-source",
59+
"userId": "your-user-id",
60+
"oss": {
61+
"vectorStore": {
62+
"provider": "qdrant",
63+
"config": { "host": "localhost", "port": 6333 }
64+
}
65+
}
66+
}
67+
```
68+
69+
---
70+
971
## What it does
1072

1173
The plugin registers five tools with OpenClaw that the resident AI (or any agent) can call:
@@ -20,8 +82,8 @@ The plugin registers five tools with OpenClaw that the resident AI (or any agent
2082

2183
Two automatic behaviors wrap each agent turn:
2284

23-
- **Auto-recall** — before a turn, retrieves relevant memories from both session and long-term scopes and injects them into the agent's context so Kite "remembers"
24-
- **Auto-capture** — after a turn, extracts and stores key facts from the conversation so Kite "learns"
85+
- **Auto-recall** — before a turn, retrieves relevant memories from both session and long-term scopes and injects them into the agent's context so your foxlight fox "remembers"
86+
- **Auto-capture** — after a turn, extracts and stores key facts from the conversation so your foxlight fox "learns"
2587

2688
---
2789

@@ -61,9 +123,9 @@ If `baseUrl` is not set, the plugin falls back to the upstream Mem0 SDK (platfor
61123

62124
---
63125

64-
## Configuration
126+
## Configuration reference
65127

66-
Configure via OpenClaw's plugin settings UI or directly in your OpenClaw config.
128+
Full list of available options:
67129

68130
| Key | Type | Default | Description |
69131
|-----|------|---------|-------------|

0 commit comments

Comments
 (0)