barry-cache 0.2.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,343 @@
+# Barry Cache
+
+<p align="center">
+  <img src="assets/barry-cache.png" alt="Barry Cache" width="420">
+</p>
+
+Barry Cache remembers your repo.
+
+It creates source-backed context files for coding agents, validates them, and gives agents a deterministic CLI for loading the smallest useful slice of project knowledge.
+
+## Reasoning
+
+Barry Cache exists because coding agents need durable project context that is shared, reviewable, and smaller than the whole repository. Private assistant memory, ad hoc chat history, and vendor-specific instruction files drift apart; Barry keeps the source of truth in the repo and lets every agent load the same facts.
+
+The structure is intentionally layered: canonical context lives in `docs/context/`, operational continuity lives in `.context-state/`, and generated retrieval data lives in `.context-cache/`. Canonical facts stay source-backed and validated, while `route`, `search`, `load`, and `resume` project only the relevant feature pack into an agent session.
+
+That gives Barry three core advantages: it is agent-agnostic, because adapters point to one canonical context; auditable, because facts carry stable IDs and source references; and context-efficient, because agents start from a small routed slice instead of rereading the whole codebase.
+
+## Quick Start
+
+```bash
+npx barry-cache init
+```
+
+This bootstraps Barry Cache in the current repository. It creates `docs/context/`, patches agent instruction files, adds npm scripts when a `package.json` exists, and creates ignored runtime folders for handoffs and caches.
+
+By default, `init` writes instruction files for all supported agents. To keep the repo focused on one agent, pass `--agents`. For example, Codex-only setup writes `AGENTS.md` but skips Copilot, Cursor, Claude, Gemini, and `llms.txt` adapters:
+
+```bash
+npx barry-cache init --agents codex
+```
+
+For non-interactive setup, use:
+
+```bash
+npx barry-cache init --yes
+```
+
+To preview the setup without writing files, use:
+
+```bash
+npx barry-cache init --dry-run
+```
+
+## Command Reference
+
+### `barry-cache init`
+
+Creates or updates the Barry Cache project structure.
+
+```bash
+barry-cache init
+barry-cache init --yes
+barry-cache init --dry-run
+barry-cache init --agents codex
+```
+
+It writes the canonical context directory, schemas, selected agent instruction files, and the managed `.gitignore` block.
+
+Use this when adding Barry Cache to a repo for the first time or regenerating adapter files after an upgrade.
+
+Flags:
+- `--yes`: run with conservative defaults.
+- `--dry-run`: report planned writes and updates without changing files.
+- `--agents <list>`: choose instruction adapters to generate. Use `all` (default), `none`, or a comma-separated list from `codex`, `cursor`, `copilot`, `claude`, `gemini`, and `llms`.
+
+### `barry-cache validate`
+
+Checks whether the repo context is structurally valid.
+
+```bash
+barry-cache validate
+```
+
+It verifies required context files exist and validates every fact row in `docs/context/features/*/FACTS.jsonl`.
+
+Use this after editing context files, importing memory, or before committing Barry Cache changes.
+
+### `barry-cache doctor`
+
+Runs the same health check as `validate`, but phrases the result as a setup health report.
+
+```bash
+barry-cache doctor
+```
+
+Use this when you want to know whether Barry Cache is installed correctly in the repository.
+
+### `barry-cache route`
+
+Scores feature context packs against a task and returns the most relevant routes.
+
+```bash
+barry-cache route --task "fix playback drift"
+```
+
+It reads `docs/context/features/*` and matches the task against feature README text, ID maps, graph edges, and facts.
+
+Use this when deciding which context pack an agent should load before doing work.
+
+### `barry-cache search`
+
+Searches feature packs and facts for a query.
+
+```bash
+barry-cache search --query "transport clock"
+```
+
+It returns matching feature packs and fact records with route, score, source, and text.
+
+Use this when you know a term, file, component, or concept and want to find the relevant memory.
+
+### `barry-cache load`
+
+Loads one feature context pack.
+
+```bash
+barry-cache load --route renderer-runtime
+```
+
+It returns the feature README, facts, and source file list for `docs/context/features/<route>/`.
+
+Use this after `route` or `search` selects a specific feature.
+
+### `barry-cache resume`
+
+Builds an agent startup brief for a task.
+
+```bash
+barry-cache resume --task "fix playback drift"
+```
+
+It routes the task, selects the top context packs, and returns an execution contract with the first action, edit scope, and validation commands.
+
+Use this at the start of a Codex, Claude, Cursor, Copilot, Gemini, or other coding-agent session.
+
+### `barry-cache finalize`
+
+Records the outcome of a work session.
+
+```bash
+barry-cache finalize --status success --summary "Updated renderer clock context"
+```
+
+```bash
+barry-cache finalize --status partial --summary "Found root cause but did not patch"
+```
+
+It appends a JSONL handoff record to `.context-state/handoffs/handoffs.jsonl`.
+
+Use this before ending a meaningful work session so the next agent can recover what happened.
+
+Statuses:
+- `success`: the task was completed.
+- `partial`: some useful progress was made.
+- `blocked`: the task cannot proceed without external input.
+- `failed`: the attempted approach did not work.
+
+### `barry-cache review`
+
+Opens a local browser tool for inspecting memory.
+
+```bash
+barry-cache review
+barry-cache review --port 8787
+barry-cache review --open
+barry-cache review --json
+```
+
+Browser mode serves a feature-first relational tree explorer and inspector at `http://127.0.0.1:8787` by default. The tree supports feature selection, grouping, related-fact activation, local expansion, and zoom/pan for larger memory sets.
+
+JSON mode exports the same graph/list/timeline/tree model without starting a long-running server.
+
+Use this when you want to audit what Barry Cache currently knows.
+
+### `barry-cache import`
+
+Imports memory from another system.
+
+```bash
+barry-cache import --source pulpcut-kb --from /path/to/pulpcut-frontend
+```
+
+```bash
+barry-cache import --source pulpcut-kb --from /path/to/pulpcut-frontend --dry-run --json
+```
+
+Currently supported source:
+- `pulpcut-kb`: imports old PulpCut KB folders from `docs/<feature>/`.
+
+The PulpCut importer converts:
+- `docs/KB_INDEX.md` into feature README route context.
+- `docs/<feature>/IDMAP.md` into `docs/context/features/<feature>/IDMAP.md`.
+- `docs/<feature>/KG.adj` into `docs/context/features/<feature>/KG.adj`.
+- `docs/<feature>/FACTS.jsonl` old `{id,s,p,o,src}` records into Barry `{id,subject,predicate,object,src,status,kind,updated_at}` facts.
+
+Use `--dry-run --json` first when importing a large memory base.
+
+### `barry-cache generate-adapters`
+
+Reports that adapter generation is handled by `init`.
+
+```bash
+barry-cache generate-adapters
+```
+
+This command exists as a stable placeholder for future explicit adapter regeneration. For now, run `barry-cache init` to regenerate agent adapter files.
+
+### `barry-cache lint-wiki`
+
+Runs wiki lint checks.
+
+```bash
+barry-cache lint-wiki
+```
+
+This is currently a lightweight placeholder and returns success. It is reserved for future checks over generated or maintained wiki-style context pages.
+
+## Common Workflows
+
+### Add Barry Cache To A Repo
+
+Run this once from the repository root:
+
+```bash
+npx barry-cache init
+```
+
+After this, Barry Cache writes short instructions into agent-facing files such as `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`, `.cursor/rules/barry-cache.mdc`, and `.github/copilot-instructions.md`.
+
+For a Codex-only repo, use:
+
+```bash
+npx barry-cache init --agents codex
+```
+
+Those generated files tell coding agents how to use Barry before they edit the repo.
+
+### Ask An Agent To Work On A Task
+
+Usually, you do not need to run `barry-cache resume` yourself.
+
+Ask your coding agent normally:
+
+```text
+Fix playback drift in the editor.
+```
+
+Because `barry-cache init` added instructions to the repo, the agent should run this before non-trivial work:
+
+```bash
+barry-cache resume --task "fix playback drift in the editor"
+```
+
+The agent then uses the returned routes to load focused context:
+
+```bash
+barry-cache load --route editor-media-runtime
+```
+
+This keeps the agent from reading every context file in the repo.
+
+If an agent ignores the repo instructions, prompt it explicitly:
+
+```text
+Before editing, follow Barry Cache protocol:
+1. Run barry-cache resume --task "<my task>".
+2. Load the returned route context.
+3. Do the work.
+4. Run validation.
+5. Finalize the session if useful.
+```
+
+### Inspect Context Yourself
+
+Use these commands when you want to see what Barry would give an agent:
+
+```bash
+barry-cache route --task "fix playback drift"
+barry-cache search --query "transport clock"
+barry-cache load --route editor-media-runtime
+```
+
+Use the browser review tool for a broader overview:
+
+```bash
+barry-cache review
+```
+
+### Save Agent Sessions
+
+At the end of a meaningful session, ask the agent:
+
+```text
+Save this session to Barry Cache.
+
+Rules:
+1. Record the session outcome with barry-cache finalize.
+2. Promote only source-backed implementation facts into docs/context/features/*/FACTS.jsonl.
+3. Put uncertain notes, blockers, and next steps in operational memory, not canonical facts.
+4. Update IDMAP.md or KG.adj only when new source IDs or relationships are needed.
+5. Run barry-cache validate before finishing.
+```
+
+The minimum useful save is:
+
+```bash
+barry-cache finalize --status success --summary "Short session outcome"
+```
+
+This writes an operational handoff into `.context-state/handoffs/handoffs.jsonl`. It does not automatically turn chat content into canonical facts.
+
+### Import And Review Old Memory
+
+When migrating an old PulpCut KB, preview the import first:
+
+```bash
+barry-cache import --source pulpcut-kb --from /path/to/pulpcut-frontend --dry-run --json
+```
+
+If the result looks right, apply it and validate:
+
+```bash
+barry-cache import --source pulpcut-kb --from /path/to/pulpcut-frontend
+barry-cache validate
+```
+
+Then inspect the imported memory:
+
+```bash
+barry-cache review
+```
+
+## Development
+
+```bash
+bun install
+bun test
+bun run typecheck
+bun run build
+```
+
+The repository uses Bun for development and builds a Node-compatible CLI for npm distribution.