@opum-ai/lore weekly downloads statistics

lore

A thin, OKF-native documentation CLI that couples repo-resident docs to Backlog.md, Quest, or Jira tasks and serves them to coding agents and humans — CLI-first.

lore makes your repository's docs/ tree a first-class, agent-readable Open Knowledge Format bundle, couples that bundle to task-tracker records, and exposes it through a deterministic, non-interactive CLI. The repository is the single source of truth — the bundle is plain markdown with YAML frontmatter that renders on GitHub, in Obsidian, and under MkDocs/Docusaurus, with or without lore installed.

Tracker backend is a choice, not a dependency. `lore init --tracker selects it; quest and jira` are just as first-class as the original backlog integration below, each with its own adapter and coupling contract. lore init's interactive wizard checks whichever binary is on PATH and offers to migrate an existing Backlog.md project into Quest (--migrate-backlog) when both are present. The rest of this README documents the original, most-detailed integration — Backlog.md — as a worked example of the coupling contract; see lore init --help for the Quest and Jira flags.

lore is thin and zero-config by design. It does not reimplement Backlog.md, Confluence, or the documentation consumers it scaffolds for. Its core is deterministic with no LLM dependency — every command is reproducible, idempotent, and CI/agent-safe (non-interactive by default, stable semantic exit codes, machine-readable --json).

• Built on Bun + TypeScript with an exact-pinned Commander parser fed by Lore's capability manifest; Lore still owns output, errors, and process lifecycle. • Published on npm as @opum-ai/lore@0.13.0 (bin lore) with six exact-pinned platform packages, including Windows ARM64. • The agent bridge is a generated .claude/skills/lore/SKILL.md plus a tiny CLAUDE.md nudge and lore instructions. An **MCP server is secondary and deferred to v2**.

Status: 0.13.0 released. Tag v0.13.0, the qualified workflow artifacts, all seven public @opum-ai/lore* npm packages with latest moved on each, and a clean-registry install agree on 0.13.0. No quest pairing is claimed for this version by its number. 0.8.0 was released as a pair with quest 0.9.0 — deliberately NOT the same number; whether any lore version and any quest version form a qualified pair is measured by opum-cli-e2e, not implied by either version string. "The pair" means the two CLIs are released and qualified TOGETHER, not that they carry matching version strings. Exact-version lockstep was the earlier convention and it was retired by decision, not by drift: lore and quest have independent change sets, and a matched version string that is not a matched contract is worse than an honestly different one, because it invites callers to treat the number as a compatibility check. **Detect a capability by presence, never by comparing versions** — one version string has already been observed naming two different byte-sets. The pair is qualified end to end by opum-cli-e2e, and that qualification, not the numbering, is what binds them.

Releases are currently manual, not a single dispatch. OIDC trusted publishing is configured on every package but cannot authenticate: GitHub issues immutable-format OIDC subject claims for this repository and npm matches the classic form, so publish: true fails with E404 (LCLI-482). Every release after 0.6.0 has therefore been published with scripts/publish-release.sh and, unlike 0.6.0, carries no provenance attestation — a manual publish cannot mint one, and provenance requires the CI OIDC path. An absent attestation here is expected and is not evidence of tampering. See Lore CLI release truth.

The Backlog.md integration: lore reads it via JSON

The section below documents lore's original tracker integration in full technical detail as a worked example; --tracker quest and --tracker jira have their own contracts, summarized above and covered in docs/reference/.

lore couples docs to tasks by reading Backlog.md's JSON output — not by scraping text and not by importing Backlog.md internals or hand-editing its task files. It parses a canonical {schemaVersion, kind, data} envelope from backlog task list --json, backlog task view --json, and `backlog search --json. There is no --plain` text-parser fallback — that is a deliberate decision to keep the coupling robust.

Backlog.md did not originally ship this JSON surface. It merged upstream in MrLesk/Backlog.md as PR #790 and shipped in the v1.49.0 tagged release (2026-08-02). lore has no package or git dependency on Backlog.md and invokes the user-installed backlog executable (>=1.49.0) on PATH. A capability probe enforces the JSON contract and fails loud when the installed binary cannot provide it.

See the runbook: Backlog.md --json patch.

Coexistence rules lore follows so it never fights Backlog.md:

• Writes go through backlog task create / backlog task edit — lore captures the new id from the Created task line and never writes backlog/tasks/*.md directly. • Back-references live on the task as a queryable label doc: (Backlog drops unknown frontmatter on edit, so lore never stores its own metadata on tasks). • Backlog runs with auto_commit=false; lore is the sole committer of backlog/ (it does the git add/commit of task files itself), with check_active_branches=false and remote_operations=false.

Full details: Backlog CLI contract and Backlog JSON schema.

Install

The package and bin are @opum-ai/lore and lore:

Starting with 0.2.0, the launcher installs only the matching script-free platform package, so a current install does not require an install-script approval exception. Qualified macOS/Linux executables embed LadybugDB's native addon at build time. Windows continues to use the reference backend and installs no LadybugDB package.

Or add it to a project:…

Description from the npm listing.