@lorekit/cli 1.4.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 +20 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,33 @@
|
|
|
1
1
|
# @lorekit/cli
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
checks against your LoreKit MCP server — a small, zero-dependency Node CLI.
|
|
3
|
+
> The fastest way to give your AI coding agent a memory that survives the session.
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
CI included. This CLI wires an agent up to it in two commands.
|
|
5
|
+
[](https://www.npmjs.com/package/@lorekit/cli)
|
|
6
|
+
[](../../LICENSE)
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
[LoreKit](https://github.com/mthines/lorekit) gives coding agents a **shared,
|
|
9
|
+
persistent memory**: a lesson one agent learns — a migration gotcha, a
|
|
10
|
+
flaky-test fix, a costly wrong assumption — is stored once and recalled by every
|
|
11
|
+
other agent, in every session, on every machine, CI included.
|
|
11
12
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
This is the CLI that connects your agent to it. One command scaffolds
|
|
14
|
+
everything — the memory skill, the MCP connection, and the lifecycle hooks — and
|
|
15
|
+
it's a zero-dependency Node binary that also runs fully offline against local
|
|
16
|
+
markdown files if you never want to sign up for anything.
|
|
16
17
|
|
|
17
18
|
```bash
|
|
18
19
|
npm install -g @lorekit/cli
|
|
19
|
-
lorekit install
|
|
20
|
-
lorekit doctor
|
|
20
|
+
lorekit install # wires up the skill, MCP server, and hooks
|
|
21
|
+
lorekit doctor # verify it's all green
|
|
21
22
|
```
|
|
22
23
|
|
|
23
|
-
|
|
24
|
+
## Install
|
|
25
|
+
|
|
26
|
+
The quickstart above uses the **global install — recommended.** You get one
|
|
27
|
+
pinned version, the `lorekit` command stays on your `PATH`, and the plugin hooks
|
|
28
|
+
(which call `lorekit hook` on every lifecycle event) fire instantly instead of
|
|
29
|
+
paying an `npx` resolution cost each time. Upgrade later with
|
|
30
|
+
`npm install -g @lorekit/cli@latest`.
|
|
24
31
|
|
|
25
32
|
Prefer not to install anything? Run it on demand with `npx` — same commands,
|
|
26
33
|
always the latest version, fetched and cached per use:
|