@opum-ai/lore 0.6.0 → 0.6.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/LICENSE +1 -1
- package/README.md +28 -12
- package/package.json +24 -9
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,15 +1,26 @@
|
|
|
1
1
|
# lore
|
|
2
2
|
|
|
3
3
|
> A thin, OKF-native documentation CLI that couples repo-resident docs to
|
|
4
|
-
> Backlog.md and serves them to coding agents and
|
|
4
|
+
> Backlog.md, Quest, or Jira tasks and serves them to coding agents and
|
|
5
|
+
> humans — CLI-first.
|
|
5
6
|
|
|
6
7
|
`lore` makes your repository's `docs/` tree a first-class, agent-readable
|
|
7
8
|
[Open Knowledge Format](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf)
|
|
8
|
-
bundle, couples that bundle to
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
9
|
+
bundle, couples that bundle to task-tracker records, and exposes it through a
|
|
10
|
+
deterministic, non-interactive CLI. The repository is the single source of
|
|
11
|
+
truth — the bundle is plain markdown with YAML frontmatter that renders on
|
|
12
|
+
GitHub, in Obsidian, and under MkDocs/Docusaurus, with or without `lore`
|
|
13
|
+
installed.
|
|
14
|
+
|
|
15
|
+
**Tracker backend is a choice, not a dependency.** `lore init --tracker
|
|
16
|
+
<quest|backlog|jira|none>` selects it; `quest` and `jira` are just as
|
|
17
|
+
first-class as the original `backlog` integration below, each with its own
|
|
18
|
+
adapter and coupling contract. `lore init`'s interactive wizard checks
|
|
19
|
+
whichever binary is on `PATH` and offers to migrate an existing Backlog.md
|
|
20
|
+
project into Quest (`--migrate-backlog`) when both are present. The rest of
|
|
21
|
+
this README documents the original, most-detailed integration —
|
|
22
|
+
[Backlog.md](https://github.com/MrLesk/Backlog.md) — as a worked example of
|
|
23
|
+
the coupling contract; see `lore init --help` for the Quest and Jira flags.
|
|
13
24
|
|
|
14
25
|
`lore` is **thin** and **zero-config** by design. It does not reimplement
|
|
15
26
|
Backlog.md, Confluence, or the documentation consumers it scaffolds for. Its
|
|
@@ -19,15 +30,15 @@ semantic exit codes, machine-readable `--json`).
|
|
|
19
30
|
|
|
20
31
|
- Built on **Bun + TypeScript** with an exact-pinned **Commander** parser fed by
|
|
21
32
|
Lore's capability manifest; Lore still owns output, errors, and process lifecycle.
|
|
22
|
-
- Published on npm as **`@opum-ai/lore@0.
|
|
33
|
+
- Published on npm as **`@opum-ai/lore@0.6.0`** (bin `lore`) with six
|
|
23
34
|
exact-pinned platform packages, including Windows ARM64.
|
|
24
35
|
- The agent bridge is a generated **`.claude/skills/lore/SKILL.md`** plus a tiny
|
|
25
36
|
CLAUDE.md nudge and `lore instructions`. An **MCP server is secondary and
|
|
26
37
|
deferred to v2**.
|
|
27
38
|
|
|
28
|
-
> **Status: 0.
|
|
39
|
+
> **Status: 0.6.0 released.** Tag `v0.6.0`, the qualified workflow artifacts,
|
|
29
40
|
> all seven public `@opum-ai/lore*` npm packages, and a clean registry install
|
|
30
|
-
> agree on `0.
|
|
41
|
+
> agree on `0.6.0`. Trusted Publishing is configured for every package; the
|
|
31
42
|
> owner lifted the `publish: true` prohibition on 2026-08-29 (LCLI-278), so a
|
|
32
43
|
> release is a single `gh workflow run release.yml --ref v<version> -f
|
|
33
44
|
> publish=true` dispatch. See
|
|
@@ -35,7 +46,12 @@ semantic exit codes, machine-readable `--json`).
|
|
|
35
46
|
|
|
36
47
|
---
|
|
37
48
|
|
|
38
|
-
## The
|
|
49
|
+
## The Backlog.md integration: lore reads it via JSON
|
|
50
|
+
|
|
51
|
+
The section below documents `lore`'s original tracker integration in full
|
|
52
|
+
technical detail as a worked example; `--tracker quest` and `--tracker jira`
|
|
53
|
+
have their own contracts, summarized above and covered in
|
|
54
|
+
[docs/reference/](docs/reference/).
|
|
39
55
|
|
|
40
56
|
`lore` couples docs to tasks by reading Backlog.md's **JSON** output — not by
|
|
41
57
|
scraping text and not by importing Backlog.md internals or hand-editing its task
|
|
@@ -307,10 +323,10 @@ The full design lives in this repo's OKF bundle under [`docs/`](docs/index.md):
|
|
|
307
323
|
|
|
308
324
|
## Contributing
|
|
309
325
|
|
|
310
|
-
This is
|
|
326
|
+
This repository is public (`main` + `dev`; `dev` is the default branch). See
|
|
311
327
|
[CONTRIBUTING](CONTRIBUTING.md), the [Code of Conduct](CODE_OF_CONDUCT.md), and
|
|
312
328
|
[SECURITY](SECURITY.md).
|
|
313
329
|
|
|
314
330
|
## License
|
|
315
331
|
|
|
316
|
-
[MIT](LICENSE) © 2026
|
|
332
|
+
[MIT](LICENSE) © 2026 Opum AI.
|
package/package.json
CHANGED
|
@@ -1,11 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opum-ai/lore",
|
|
3
|
-
"version": "0.6.
|
|
4
|
-
"author": "
|
|
3
|
+
"version": "0.6.1",
|
|
4
|
+
"author": "Opum AI",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/opum-ai/lore-cli.git"
|
|
8
8
|
},
|
|
9
|
+
"homepage": "https://loregraph.dev",
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/opum-ai/lore-cli/issues"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"cli",
|
|
15
|
+
"documentation",
|
|
16
|
+
"docs",
|
|
17
|
+
"okf",
|
|
18
|
+
"backlog",
|
|
19
|
+
"quest",
|
|
20
|
+
"jira",
|
|
21
|
+
"ai-agents",
|
|
22
|
+
"claude-code"
|
|
23
|
+
],
|
|
9
24
|
"devDependencies": {
|
|
10
25
|
"@ladybugdb/core": "0.19.0",
|
|
11
26
|
"@biomejs/biome": "2.4.12",
|
|
@@ -23,17 +38,17 @@
|
|
|
23
38
|
"zod": "4.4.3"
|
|
24
39
|
},
|
|
25
40
|
"optionalDependencies": {
|
|
26
|
-
"@opum-ai/lore-darwin-arm64": "0.6.
|
|
27
|
-
"@opum-ai/lore-darwin-x64": "0.6.
|
|
28
|
-
"@opum-ai/lore-linux-arm64": "0.6.
|
|
29
|
-
"@opum-ai/lore-linux-x64": "0.6.
|
|
30
|
-
"@opum-ai/lore-win32-arm64": "0.6.
|
|
31
|
-
"@opum-ai/lore-win32-x64": "0.6.
|
|
41
|
+
"@opum-ai/lore-darwin-arm64": "0.6.1",
|
|
42
|
+
"@opum-ai/lore-darwin-x64": "0.6.1",
|
|
43
|
+
"@opum-ai/lore-linux-arm64": "0.6.1",
|
|
44
|
+
"@opum-ai/lore-linux-x64": "0.6.1",
|
|
45
|
+
"@opum-ai/lore-win32-arm64": "0.6.1",
|
|
46
|
+
"@opum-ai/lore-win32-x64": "0.6.1"
|
|
32
47
|
},
|
|
33
48
|
"bin": {
|
|
34
49
|
"lore": "bin/lore.cjs"
|
|
35
50
|
},
|
|
36
|
-
"description": "Thin, OKF-native documentation CLI that couples repo-resident docs to Backlog.md and serves them to agents and humans.",
|
|
51
|
+
"description": "Thin, OKF-native documentation CLI that couples repo-resident docs to Backlog.md, Quest, or Jira tasks and serves them to agents and humans.",
|
|
37
52
|
"engines": {
|
|
38
53
|
"bun": ">=1.3.14"
|
|
39
54
|
},
|