renor-engine 1.3.0 → 1.4.0
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 +13 -1
- package/bin/renor-engine.cjs +38 -0
- package/dist/BUILD.json +3 -3
- package/dist/cli.js +43 -25
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -11,8 +11,12 @@
|
|
|
11
11
|
|
|
12
12
|
Every new agent session starts from zero: you re-explain the project, last week's decision and why, the thing you corrected twice. With Renor, one agent saves it and the next one finds it. The memory is plain files you own. It runs locally, needs no account or API key, and sends nothing off your machine unless you configure a model or send anonymous usage numbers (on by default, with a first-run notice; `renor-engine telemetry off` or `DO_NOT_TRACK=1` turns them off). Your memory text is shared only if you say yes to that separately. A hosted version with no install is at <https://renor.cloud>.
|
|
13
13
|
|
|
14
|
+
Renor needs Node.js 22.16 or later (22.16+ or 24+). On an older Node, `renor-engine` prints one message saying so and exits.
|
|
15
|
+
|
|
14
16
|
## Quickstart
|
|
15
17
|
|
|
18
|
+
Requires Node.js 22.16 or later (22.16+ or 24+); older Node prints a one-line message and exits.
|
|
19
|
+
|
|
16
20
|
You need **Node 22** and git. The install is the only step that needs the network.
|
|
17
21
|
|
|
18
22
|
```bash
|
|
@@ -33,13 +37,21 @@ Downloaded a ZIP instead of cloning? It has no git history to stamp the build wi
|
|
|
33
37
|
|
|
34
38
|
## Connect your agent
|
|
35
39
|
|
|
36
|
-
**Without a clone.** With Node 22 installed, one line registers the published package. Your notes go to a hidden `.renor` folder in your home directory (`~/.renor`, printed on stderr at start; it never reuses an existing `renor` folder); to use another folder, add `-e VAULT_PATH=/absolute/path` to the `claude` line or `--env VAULT_PATH=/absolute/path` to the `codex` line. The first start downloads about
|
|
40
|
+
**Without a clone.** With Node 22 installed, one line registers the published package. Your notes go to a hidden `.renor` folder in your home directory (`~/.renor`, printed on stderr at start; it never reuses an existing `renor` folder); to use another folder, add `-e VAULT_PATH=/absolute/path` to the `claude` line or `--env VAULT_PATH=/absolute/path` to the `codex` line. The first start downloads about 12 MB and takes about 3 seconds (measured on a clean npm cache); if your agent shows one failed connection, restart it. Search is by keyword by default; the optional local meaning-search model is a separate one-time download, only when `EMBEDDING_PROVIDER=local`.
|
|
37
41
|
|
|
38
42
|
```bash
|
|
39
43
|
claude mcp add --scope user renor-local -- npx -y renor-engine mcp
|
|
40
44
|
codex mcp add renor-local -- npx -y renor-engine mcp
|
|
41
45
|
```
|
|
42
46
|
|
|
47
|
+
**Grok.** Register it for the project (Grok does not start project-scope servers in a folder it does not trust, and the session that ran this command does not have them):
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
grok mcp add --scope project renor -- npx -y renor-engine mcp
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Trust the folder in Grok, then restart Grok. Check it in three steps: (1) ask Grok to save a real decision from your project (for example, "remember that we use Postgres 16 for the orders service"); (2) restart Grok; (3) in the new session ask "which database does the orders service use?" and it should answer from Renor. To turn telemetry off, set `DO_NOT_TRACK=1` in the environment Grok runs in.
|
|
54
|
+
|
|
43
55
|
For Cursor or any other client, the server is the command `npx` with the arguments `-y renor-engine mcp`. In Cursor or VS Code (GitHub Copilot), one click adds it:
|
|
44
56
|
|
|
45
57
|
[](https://cursor.com/install-mcp?name=renor-local&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInJlbm9yLWVuZ2luZSIsIm1jcCJdfQ%3D%3D)
|
|
@@ -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