renor-engine 1.3.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -74
- package/bin/renor-engine.cjs +38 -0
- package/dist/BUILD.json +3 -3
- package/dist/cli.js +65 -26
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,131 +1,133 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/renor-logo-light.svg">
|
|
5
|
+
<img alt="Renor" src="docs/assets/renor-logo-dark.svg" width="420">
|
|
6
|
+
</picture>
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
*Self-hosted Renor, real session: Claude Code saves a decision, a fresh Codex session recalls it. Waiting time sped up.*
|
|
8
|
+
<h3>Shared memory for coding agents, over MCP.</h3>
|
|
7
9
|
|
|
8
|
-
|
|
10
|
+
What one agent learns in a session, every agent knows in the next.
|
|
9
11
|
|
|
10
|
-
|
|
12
|
+
</div>
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
## How it works
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
1. **Tell one agent once:** a decision, a root cause, a correction.
|
|
17
|
+
2. **Renor saves it** as plain Markdown you own.
|
|
18
|
+
3. **Every agent recalls it** in its next session: Claude Code, Codex, Cursor, Grok, Gemini, VS Code, OpenCode, Pi or any MCP client.
|
|
15
19
|
|
|
16
|
-
|
|
20
|
+
## Quickstart
|
|
17
21
|
|
|
18
|
-
|
|
19
|
-
git clone https://github.com/renorai/renor-engine.git
|
|
20
|
-
cd renor-engine
|
|
21
|
-
node -v # v22.16 or newer
|
|
22
|
-
npm ci && npm run build
|
|
23
|
-
node scripts/smoke-self-hosted.mjs
|
|
24
|
-
```
|
|
22
|
+
Two ways in. Both take under a minute.
|
|
25
23
|
|
|
26
|
-
|
|
24
|
+
### Hosted: the easiest path
|
|
27
25
|
|
|
28
|
-
```
|
|
29
|
-
|
|
26
|
+
```bash
|
|
27
|
+
npx renor connect --client claude-code
|
|
30
28
|
```
|
|
31
29
|
|
|
32
|
-
|
|
30
|
+
`--client` is `claude-code`, `codex`, `cursor`, `grok`, `gemini`, `vscode`, `opencode` or `pi`. One command adds Renor to that app, signs you in through the app's own flow (no token to copy), writes the memory rule below, and ends with a live check that your workspace answers. Search is hybrid (keywords and meaning). Sign up at [renor.cloud](https://renor.cloud).
|
|
33
31
|
|
|
34
|
-
|
|
32
|
+
### Self-hosted: the private path
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
Your memory stays in a folder on your machine. No account, no API key. You need Node.js 22.16 or later (22.16+ or 24+); on an older Node, `renor-engine` prints one line saying so and exits.
|
|
37
35
|
|
|
38
36
|
```bash
|
|
39
37
|
claude mcp add --scope user renor-local -- npx -y renor-engine mcp
|
|
40
38
|
codex mcp add renor-local -- npx -y renor-engine mcp
|
|
41
39
|
```
|
|
42
40
|
|
|
43
|
-
|
|
41
|
+
Restart the agent. The first start downloads about 12 MB, and the first Renor call works about 3 seconds after an empty start. Notes go to `~/.renor` (set `VAULT_PATH` to use another folder).
|
|
44
42
|
|
|
45
|
-
[
|
|
46
|
-
[](https://vscode.dev/redirect/mcp/install?name=renor-local&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22renor-engine%22%2C%22mcp%22%5D%7D)
|
|
43
|
+
**Then add [the memory rule](#the-memory-rule)** to the agent's instructions file, so it saves on its own.
|
|
47
44
|
|
|
48
|
-
|
|
45
|
+
**Cursor or VS Code**, one click:
|
|
49
46
|
|
|
50
|
-
|
|
47
|
+
[](https://cursor.com/install-mcp?name=renor-local&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInJlbm9yLWVuZ2luZSIsIm1jcCJdfQ%3D%3D)
|
|
48
|
+
[](https://vscode.dev/redirect/mcp/install?name=renor-local&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22renor-engine%22%2C%22mcp%22%5D%7D)
|
|
51
49
|
|
|
52
|
-
|
|
50
|
+
**Grok.** Grok starts project servers only in a folder it trusts, so register Renor in the project:
|
|
53
51
|
|
|
54
52
|
```bash
|
|
55
|
-
|
|
56
|
-
node dist/cli.js index
|
|
53
|
+
grok mcp add --scope project renor -- npx -y renor-engine mcp
|
|
57
54
|
```
|
|
58
55
|
|
|
59
|
-
|
|
56
|
+
Trust the folder in Grok, then restart Grok. To check it: ask Grok to save a real decision from your project, restart Grok, and ask about it in the new session. To turn telemetry off, set `DO_NOT_TRACK=1` in the environment Grok runs in. Paste [the memory rule](#the-memory-rule) into the project's `AGENTS.md`.
|
|
57
|
+
|
|
58
|
+
**Any other MCP client:** the command is `npx` with the arguments `-y renor-engine mcp` (stdio).
|
|
60
59
|
|
|
61
|
-
**
|
|
60
|
+
**Check it works:**
|
|
62
61
|
|
|
63
62
|
```bash
|
|
64
|
-
|
|
63
|
+
npx renor-engine status
|
|
65
64
|
```
|
|
66
65
|
|
|
67
|
-
|
|
66
|
+
Then tell your agent a real decision ("remember that the orders service uses Postgres 16"), start a new session, and ask about it.
|
|
68
67
|
|
|
69
|
-
|
|
68
|
+
Running it on a server or with Docker: [docs/self-hosting.md](docs/self-hosting.md).
|
|
70
69
|
|
|
71
|
-
|
|
72
|
-
codex mcp add renor-local --env VAULT_PATH="${VAULT_PATH:?run the export line above first}" -- "$(node -p process.execPath)" "$PWD/dist/cli.js" mcp
|
|
73
|
-
```
|
|
70
|
+
Several agents on one memory: start each with its own `RENOR_CONNECTION_NAME` and they get the multi-agent ("hive") tools ([details](docs/self-hosting.md)).
|
|
74
71
|
|
|
75
|
-
|
|
72
|
+
## The memory rule
|
|
76
73
|
|
|
77
|
-
|
|
74
|
+
Five lines that make agents save decisions, corrections and facts on their own. In our Grok test (grok-4.7, renor-engine 1.4.0, 3 Nov 2026), agents with the rule saved in 8 of 8 sessions and the next session recalled 5 of 5 project facts.
|
|
78
75
|
|
|
79
|
-
|
|
76
|
+
`renor connect` writes it for you. Self-hosted, paste it into `~/.claude/CLAUDE.md` (Claude Code), `~/.codex/AGENTS.md` (Codex) or the project's `AGENTS.md` (Grok):
|
|
80
77
|
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
args: [process.cwd() + "/dist/cli.js", "mcp"], env: { VAULT_PATH: process.env.VAULT_PATH } } } }, null, 2))'
|
|
84
|
-
```
|
|
78
|
+
```md
|
|
79
|
+
## Renor memory
|
|
85
80
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
81
|
+
Renor is connected to this app and remembers across sessions.
|
|
82
|
+
- Before deciding anything non-trivial, recall first: one get_context call is usually enough.
|
|
83
|
+
- Save with remember when the user makes a decision, corrects you, or states a fact that should outlive this chat. Include the reason.
|
|
84
|
+
- Save the specific value (a port, a name, a path), not a summary of it.
|
|
85
|
+
- Do not save secrets, or things that are already in the code.
|
|
86
|
+
```
|
|
89
87
|
|
|
90
|
-
|
|
88
|
+
Self-hosted, the local tools are `search`, `remember_fact` and `note`; agents map the rule onto them ([tool list](skill/SKILL.md#stdio-renor-engine-mcp)).
|
|
91
89
|
|
|
92
|
-
##
|
|
90
|
+
## What runs on your machine
|
|
93
91
|
|
|
94
|
-
|
|
92
|
+
- **Your memory is plain Markdown** in one folder you own. Edit it with anything; back it up like any folder.
|
|
93
|
+
- **SQLite** holds the search index, next to the notes. It is rebuilt from the Markdown at any time.
|
|
94
|
+
- **No embedding model needed.** Search is by keyword; when the exact words miss, it retries with word stems. Hybrid search (keywords and meaning) is the hosted default; self-hosters can opt in to OpenAI or a local model ([details](docs/self-hosting.md#embeddings)).
|
|
95
|
+
- **Small:** a 1.8 MB package, about 5 MB installed. About 143 MB of memory with 1,000 saved memories.
|
|
96
|
+
- **Telemetry:** anonymous usage numbers (never text, names or paths) are on by default, with a notice on first run. `renor-engine telemetry off` or `DO_NOT_TRACK=1` turns them off. Your memory text is never shared unless you say yes to that separately. Every field: [docs/TELEMETRY.md](docs/TELEMETRY.md).
|
|
95
97
|
|
|
96
|
-
|
|
98
|
+
## Benchmarks
|
|
97
99
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
100
|
+
| Benchmark | Renor | Setup |
|
|
101
|
+
| --- | --- | --- |
|
|
102
|
+
| LongMemEval-S | **98.4%** (492/500) | Deep search, off by default |
|
|
103
|
+
| LongMemEval-S | **94.4%** (472/500) | Default settings |
|
|
104
|
+
| LoCoMo (categories 1 to 4) | **96.7%** (1,489/1,540) | Deep search |
|
|
105
|
+
| BEAM 128K / 1M / 10M | **76.2 / 74.7 / 60.2** | Deep search, score out of 100 |
|
|
106
|
+
| ConvoMem | **88.4%** (191/216) | Default search, 100 conversations per memory |
|
|
105
107
|
|
|
106
|
-
|
|
108
|
+
Claude Opus 5.5 answers LongMemEval, LoCoMo and BEAM; DeepSeek V4.1 Flash answers ConvoMem (a research run). One run each, Oct 2026. Deep search is top-K 50 with a 4,000-token budget (`RENOR_TOPK_SCALES_BUDGET=1`). Judges and methods for every run: [renor.cloud/research](https://renor.cloud/research).
|
|
107
109
|
|
|
108
|
-
##
|
|
110
|
+
## Build from source
|
|
109
111
|
|
|
110
|
-
|
|
111
|
-
| --- | --- |
|
|
112
|
-
| Your notes | Any Markdown files in `$VAULT_PATH`. Renor reads them; edit them with anything. |
|
|
113
|
-
| What agents save | Appended as Markdown in the same folder: facts to `System/Memory Events Ledger.md`, notes to `Memory/Daily/<date>.md`. |
|
|
114
|
-
| Search index | SQLite at `$VAULT_PATH/.semantic-memory/index.db`. Derived: `node dist/cli.js index` rebuilds it from the Markdown. |
|
|
112
|
+
You need Node.js 22.16 or later and git.
|
|
115
113
|
|
|
116
|
-
|
|
114
|
+
```bash
|
|
115
|
+
git clone https://github.com/renorai/renor-engine.git
|
|
116
|
+
cd renor-engine
|
|
117
|
+
npm ci && npm run build
|
|
118
|
+
node scripts/smoke-self-hosted.mjs
|
|
119
|
+
```
|
|
117
120
|
|
|
118
|
-
|
|
121
|
+
The last command starts the MCP server in a temporary folder, saves one fact, finds it again and ends with `PASS: self-hosted stdio MCP can remember and retrieve a current fact.` It never touches your notes. Downloaded a ZIP instead of cloning? Build with `RENOR_BUILD_COMMIT=0000000 npm run build`. Connecting a local build to each agent: [docs/self-hosting.md](docs/self-hosting.md).
|
|
119
122
|
|
|
120
|
-
##
|
|
123
|
+
## Learn more
|
|
121
124
|
|
|
122
|
-
|
|
123
|
-
- [skill/SKILL.md](skill/SKILL.md): instructions to give your agent so it recalls and saves memory without being asked. Most of it names the hosted tools (`get_context`, `remember`); the `renor-local` server above has other names (`search`, `remember_fact`, `note`), listed in its [Stdio section](skill/SKILL.md#stdio-renor-engine-mcp).
|
|
125
|
+
[Docs](https://renor.mintlify.app) · [Self-hosting, servers and Docker](docs/self-hosting.md) · [Every setting](docs/ENVIRONMENT-VARIABLES.md) · [Telemetry](docs/TELEMETRY.md)
|
|
124
126
|
|
|
125
|
-
|
|
127
|
+
## License and contributing
|
|
126
128
|
|
|
127
|
-
|
|
129
|
+
The engine is **Apache-2.0** ([LICENSE](LICENSE)); 1.0.0 was released under AGPL-3.0; 1.1.0 and later are Apache-2.0; files imported from the upstream project stay ISC ([NOTICE](NOTICE), [UPSTREAM.md](UPSTREAM.md)). The `renor` CLI, the SDKs and the integrations are MIT.
|
|
128
130
|
|
|
129
|
-
Contributions are welcome
|
|
131
|
+
Contributions are welcome: [CONTRIBUTING.md](CONTRIBUTING.md) has setup, tests and good first issues. Sign off each commit with the [DCO](https://developercertificate.org/) (`git commit -s`); there is no CLA. Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
|
|
130
132
|
|
|
131
133
|
If Renor saves you re-explaining, a [⭐](https://github.com/renorai/renor-engine) helps other developers find it.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
// Entry point for `renor-engine`. Plain old-syntax JavaScript on purpose: it must run on a Node too old for the
|
|
4
|
+
// engine's own code, check the version, and only then load dist/cli.js.
|
|
5
|
+
// Keep the range in step with "engines.node" in package.json.
|
|
6
|
+
|
|
7
|
+
function parse(version) {
|
|
8
|
+
var m = /^v?(\d+)\.(\d+)/.exec(String(version));
|
|
9
|
+
return m ? { major: Number(m[1]), minor: Number(m[2]) } : null;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
// Supported: ^22.16.0 || >=24
|
|
13
|
+
function nodeVersionSupported(version) {
|
|
14
|
+
var v = parse(version);
|
|
15
|
+
if (!v) return false;
|
|
16
|
+
if (v.major >= 24) return true;
|
|
17
|
+
return v.major === 22 && v.minor >= 16;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function unsupportedMessage(version) {
|
|
21
|
+
return (
|
|
22
|
+
"renor-engine needs Node.js 22.16 or later (22.16+ or 24+); this is " + version + ".\n" +
|
|
23
|
+
"Install a newer Node, for example: nvm install 22 && nvm use 22 (or: mise use node@22)\n"
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
function main() {
|
|
28
|
+
var found = process.versions.node;
|
|
29
|
+
if (!nodeVersionSupported(found)) {
|
|
30
|
+
process.stderr.write(unsupportedMessage(found));
|
|
31
|
+
process.exit(1);
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
require("../dist/cli.js");
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
module.exports = { nodeVersionSupported: nodeVersionSupported, unsupportedMessage: unsupportedMessage };
|
|
38
|
+
if (require.main === module) main();
|
package/dist/BUILD.json
CHANGED