memorable-cli 0.2.0 → 0.3.1

package/LICENSE

@@ -1,202 +1,66 @@
-
-                                 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.
+MEMORABLE CLI — END USER LICENSE AGREEMENT
+
+Copyright (c) 2026 Memorable. All rights reserved.
+
+This software, including its compiled artifacts, documentation, and
+accompanying materials (the "Software"), is proprietary to Memorable
+("Licensor"). It is licensed, not sold. By installing or using the Software
+you agree to these terms.
+
+1. Grant of Use. Licensor grants you a personal, non-exclusive,
+   non-transferable, non-sublicensable, revocable license to install and use
+   the Software on machines you own or control, for your own internal or
+   personal purposes, including in the course of your employment.
+
+2. Restrictions. You may not:
+   (a) redistribute, resell, rent, lease, sublicense, or host the Software as
+       a service for third parties;
+   (b) modify, adapt, translate, or create derivative works of the Software;
+   (c) reverse engineer, decompile, disassemble, deobfuscate, or otherwise
+       attempt to derive the source code, algorithms, or internal design of
+       the Software, except to the extent this restriction is unenforceable
+       under applicable law;
+   (d) use the Software, or any knowledge of its design obtained through use
+       of it, to develop or assist in developing a competing product or
+       service;
+   (e) remove, obscure, or alter any copyright, trademark, or other
+       proprietary notice.
+
+3. Service Component. Parts of the Software communicate with Licensor's
+   hosted services using an API key issued to you. Your use of those services
+   is subject to Licensor's then-current usage limits and acceptable use
+   terms. Licensor may revoke a key, or modify or discontinue the hosted
+   services, at any time. You may not share your key, circumvent quotas, or
+   use the services to build a competing service.
+
+4. Ownership. Licensor retains all right, title, and interest in and to the
+   Software, including all intellectual property rights. The Software's
+   design, algorithms, and non-public materials are trade secrets of
+   Licensor; nothing in this agreement transfers any ownership to you.
+   Feedback you provide may be used by Licensor without restriction or
+   obligation.
+
+5. Your Data. The Software processes data on your machine. Where it sends
+   data to Licensor's hosted services, it sends only the minimized,
+   identifier-scrubbed fields documented in the README. Licensor does not
+   persist request bodies. You are responsible for ensuring your use complies
+   with any obligations you owe to your employer or your own customers.
+
+6. Termination. This license terminates automatically if you breach any term,
+   and may be terminated by Licensor at any time. On termination you must
+   cease all use and remove all copies of the Software.
+
+7. No Warranty. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
+
+8. Limitation of Liability. TO THE MAXIMUM EXTENT PERMITTED BY LAW, LICENSOR
+   SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL,
+   OR EXEMPLARY DAMAGES, OR FOR ANY LOSS OF DATA, PROFITS, OR BUSINESS,
+   ARISING FROM OR RELATING TO THE SOFTWARE. LICENSOR'S TOTAL LIABILITY SHALL
+   NOT EXCEED ONE HUNDRED US DOLLARS ($100).
+
+9. Governing Law. This agreement is governed by the laws of the State of
+   California, excluding its conflict-of-laws rules.
+
+Contact: nikhil@theagi.company

package/README.md

@@ -26,15 +26,138 @@ memorable recall "rotate the TLS cert"
 memorable show <slug>
 
 memorable graph       # browse everything at localhost, rendered locally
+
+# a task that is several things at once, assembled from several procedures:
+memorable chain "add the refunds endpoint and then cover it with tests"
+
+# see what is stored and clean it up:
+memorable list                    # what recall would use, and whether it has helped
+memorable prune --superseded      # drop revisions that had their turn and lost
+```
+
+## Checking state
+
 ```
+memorable status         # backend, consent, how many procedures are stored
+memorable doctor         # every integration point, asserted — including whether
+                         # semantic recall is actually configured, not just
+                         # whether the API returned 200
+memorable install-hooks  # add the Claude Code prompt hook so recall injects
+                         # automatically at the start of a session
+memorable setup          # init + enable + AGENTS.md in one shot
+```
+
+## Revisions
+
+Recording the same task twice is safe. Identical steps refresh the stored
+revision in place; a genuinely different approach is kept beside it as a new
+revision, so a better way can be learned without destroying the one that
+already works.
+
+Recall surfaces one revision per task: a new revision gets a short trial
+window, and after that the one with the better track record wins. That record
+comes from the loop itself — when a recalled procedure is injected into a
+session, how that session ends is credited back to it. The evidence lives in
+`~/.memorable/stats.json` on your machine, never in the store, so recall never
+writes to your brain and nothing about your outcomes is shared.
+
+`memorable list` prints the slugs, which revision is preferred, how often each
+was recalled, and how often the session went well afterwards. `--all` shows
+every revision; `--json` is scriptable.
+
+## Removing procedures
+
+```
+memorable prune <slug>          # remove one
+memorable prune --stale         # ones whose files no longer exist in this tree
+memorable prune --superseded    # revisions that were tried and lost
+memorable prune --dry-run       # preview, with any of the above
+```
+
+Pruning works in **every consent mode**, including `forget`/deny: a store you
+cannot empty is not one you can trust. On the gbrain backend this rides
+gbrain's own `delete_page`, so removal is a soft delete, recoverable for 72
+hours.
+
+A trace is also refused up front when it could not possibly help — an empty
+session, or one that only read and searched without changing anything. Refusals
+are logged to `~/.memorable/rejected.jsonl` with a reason rather than dropped
+silently.
 
 ## Backends
 
 - **local** (default) — procedures live in `~/.memorable/procedures.jsonl`. Works anywhere Node runs; no other software required.
-- **gbrain** — `memorable init gbrain` stores procedures in your existing [gbrain](https://github.com/garrytan/gbrain) database instead, and unlocks automatic session capture (`memorable record`, the session-end relay, and gbrain's embedding provider for semantic recall). Requires a gbrain install and [Bun](https://bun.sh) on PATH; database commands re-exec under Bun automatically.
+- **gbrain** — `memorable init gbrain` stores procedures in your existing [gbrain](https://github.com/garrytan/gbrain) database instead, and unlocks automatic session capture (`memorable record` and the session-end relay). If your gbrain has an embedding provider configured, it is used for semantic recall instead of the extraction API's. Requires a gbrain install and [Bun](https://bun.sh) on PATH; database commands re-exec under Bun automatically.
+
+## How recall matches
+
+Three tiers, fused by reciprocal rank: an exact match on a stored file path or
+command, a lexical match on shared tokens, and a semantic match on meaning.
+Semantic is lazy — it only runs when the first two find nothing, so most
+queries stay deterministic and offline.
+
+Semantic recall needs vectors. Procedures are embedded by the extraction API
+(`bge-m3`, 1024 dimensions, run inside Memorable's own Cloudflare account, so
+the task title never reaches a third-party vendor). Only the one-line task
+title is embedded, never your file contents or conversation.
+
+If no embedding provider is reachable, procedures are still stored and recall
+still works on exact and lexical matches — but the CLI says so on every write
+rather than degrading quietly, and `memorable doctor` reports the semantic
+tier as unavailable.
 
 Switch anytime by re-running `memorable init` / `memorable init gbrain`.
 
+## Chaining: when one procedure is not the answer
+
+A long task is rarely a repeat. It is usually a new arrangement of things you
+have each done before. Retrieval cannot express that — ask for the closest
+memory and you get one procedure and a shrug for the rest.
+
+So `memorable recall` decides between two modes, and says which it picked:
+
+- **single** — one stored procedure answers the prompt.
+- **chain** — several are assembled into one ordered plan.
+
+It chains when one procedure provably cannot answer: either the prompt is
+several subgoals matching different procedures, or the best match needs a file
+that another stored procedure is the one that creates.
+
+The ordering is not guessed. A procedure that **writes** a file and one that
+**reads** it are a dependency, in that direction, and both facts are already in
+the recorded steps. Steps come out in dependency order, and steps that share no
+dependency are marked as safe to run in parallel.
+
+Two things fall out of that, and they are the point of the feature:
+
+- **A step you never asked for.** If the endpoint you asked about reads a file
+  only the migration creates, the migration is inserted and labelled — it
+  matched nothing in your prompt, and without it the plan does not run.
+- **An honest gap.** Anything memory cannot cover is printed as
+  `not covered by memory` and excluded from the claimed coverage, rather than
+  papered over with the nearest vaguely-similar procedure.
+
+`memorable chain "<task>"` runs it directly; `--render` shows the exact block
+that would be injected, `--json` is scriptable. `memorable recall --single` and
+`--chain` force either mode.
+
+Chaining is per-project. Dependencies only form between procedures that touched
+the same files, so run it where you work — a store spanning unrelated projects
+has nothing to connect.
+
+## What leaves your machine
+
+Everything is processed locally except extraction, which is one HTTPS call. That
+call carries the tool NAMES, a fixed allowlist of argument fields (`command`,
+`file_path`, `pattern`, `url`, `query` and a few siblings), and outcomes — with
+your home directory collapsed to `~`, and emails, credential-shaped strings and
+long hex digests redacted before sending.
+
+Edit bodies, file contents, and your conversation never leave the machine.
+Request bodies are never persisted or logged by the service, and embeddings run
+inside Memorable's own Cloudflare account, so nothing reaches a third-party
+vendor.
+
 ## Consent model
 
 Fail-closed. `unset` means deny: until you run `memorable enable`, nothing is written. `disable` makes memory read-only; `forget` denies everything, recall included. Recalled procedures are injected as guarded reference data — control-character-stripped, size-capped, and explicitly marked as data, not instructions.