mindslice 0.1.0__tar.gz

mindslice-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

mindslice-0.1.0/NOTICE

@@ -0,0 +1,22 @@
+MindSlice
+Copyright 2026 pancerZH and the MindSlice contributors
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+Third-party material
+--------------------
+
+The evaluation records under evals/ quote short excerpts from published
+benchmark datasets, and text that evaluated agents wrote from them: example
+questions in evals/external/results/summary.md, and card lines and values in
+the reports and audit worksheets under evals/agent/results/. That material is
+not covered by the Apache License. It remains under the licence of the dataset
+it comes from:
+
+  MEME               CC BY 4.0      https://huggingface.co/datasets/meme-benchmark/MEME
+  LoCoMo             CC BY-NC 4.0   https://github.com/snap-research/locomo
+  LongMemEval        MIT            https://huggingface.co/datasets/xiaowu0162/longmemeval-cleaned
+  MemoryAgentBench   MIT            https://huggingface.co/datasets/ai-hyz/MemoryAgentBench
+
+The datasets themselves are not redistributed. evals/external/sources.py pins
+the revision, digest and licence of each file the evaluations download.

mindslice-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: mindslice
+Version: 0.1.0
+Summary: Layered, pluggable, human-readable long-term memory engine for LLM agents (Python stdlib only).
+Author: pancerZH
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/pancerZH/MindSlice
+Project-URL: Documentation, https://github.com/pancerZH/MindSlice/blob/main/docs/getting-started.md
+Project-URL: Issues, https://github.com/pancerZH/MindSlice/issues
+Keywords: llm,agents,memory,markdown,mcp
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# MindSlice
+
+**Portable memory for AI agents, with isolation and evolution built in.**
+
+Keep project knowledge, personal preferences and shared handbooks in plain Markdown.
+Mount what an agent needs, let it learn in its own workspace, and bake those learnings
+into reusable versions. Connect through MCP, the CLI or Python.
+
+![MindSlice architecture: isolated read-only slices and a writable overlay, optional staging for approval, and bake into new slice versions.](docs/assets/architecture.svg)
+
+## Why MindSlice?
+
+**Isolation.** A *slice* is a folder of Markdown cards you can mount, unmount and share
+independently. Mounted slices stay read-only through the engine; new learning goes into
+a separate overlay. Multiple workspaces can reuse the same baseline while keeping their
+own changes. Pending edits stay outside live memory until approved.
+
+**Evolving memory.** Cards can explicitly extend or supersede earlier knowledge, so
+retrieval follows recorded relationships under your trust rules. `bake` turns selected
+changes into new slice versions, preserving the original folders and returning the new paths.
+
+[Hot/cold memory](https://docs.letta.com/v1-sdk/memory/context-hierarchy) focuses on what stays
+in context and what is retrieved later. [LLM Wiki](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f)
+focuses on compiling sources into a maintained knowledge base. MindSlice makes **memory
+boundaries and controlled evolution** first-class engine operations.
+[How these approaches fit together →](docs/concepts.md)
+
+Python 3.12+. No runtime dependencies, database server or LLM API calls inside the engine.
+
+## Get started
+
+Paste this into your coding agent:
+
+```text
+Clone https://github.com/pancerZH/MindSlice.git (or use the existing checkout).
+Read skills/mindslice-setup/SKILL.md to finish setup.
+```
+
+The agent helps you choose a workspace, connect your app, and choose how to start:
+
+| Starting point | Tool |
+| --- | --- |
+| Empty memory or a short conversation | MindSlice `init` and ordinary memory writes |
+| Existing MindSlice workspace | Connect it directly with `-w` |
+| Shared `.slice` or Markdown notes folder | MindSlice `mount`, indexed as is |
+| Documents to distill into structured cards | [MindSlice-forge](https://github.com/pancerZH/MindSlice-forge) |
+
+Forge is an optional document-conversion tool. It creates a new workspace using an agent harness;
+MindSlice handles storage, retrieval, mounting and memory evolution without needing Forge or an LLM.
+The [builder skill](skills/slice-builder/SKILL.md) guides conversion and integration with an existing workspace.
+
+Prefer manual setup? With Python 3.12+ and pipx installed:
+
+```bash
+git clone https://github.com/pancerZH/MindSlice.git
+cd MindSlice
+pipx install -e .
+mindslice init ~/mindslice
+```
+
+Then [connect your agent](docs/getting-started.md#connect-your-agent) and tell it what to remember.
+Run `mindslice -w ~/mindslice doctor`, then [verify a new session](docs/getting-started.md#verify-your-first-session).
+[Full setup guide](docs/getting-started.md) · [Review changes and bake slices](docs/workflow.md)
+
+## Documentation
+
+- [Concepts](docs/concepts.md) — isolation, evolution, and how MindSlice fits other memory architectures.
+- [Reference](docs/reference.md) — commands, Python API, MCP tools and card formats.
+- [History and recovery](docs/history-and-recovery.md) — explain memory, roll back slices, back up and restore workspaces.
+- [Build slices with Forge](skills/slice-builder/SKILL.md) — convert documents and connect the resulting workspace or slices.
+- [Maintain memory](skills/slice-maintainer/SKILL.md) — consolidate knowledge and repair relationships.
+- [Evaluations](docs/evaluations.md) · [Design](docs/design.md) · [Uninstall](skills/mindslice-setup/uninstall.md)
+
+## License
+
+[Apache License 2.0](LICENSE). Benchmark excerpts quoted in the evaluation records keep their
+datasets' licences; see [NOTICE](NOTICE).

mindslice-0.1.0/README.md

@@ -0,0 +1,77 @@
+# MindSlice
+
+**Portable memory for AI agents, with isolation and evolution built in.**
+
+Keep project knowledge, personal preferences and shared handbooks in plain Markdown.
+Mount what an agent needs, let it learn in its own workspace, and bake those learnings
+into reusable versions. Connect through MCP, the CLI or Python.
+
+![MindSlice architecture: isolated read-only slices and a writable overlay, optional staging for approval, and bake into new slice versions.](docs/assets/architecture.svg)
+
+## Why MindSlice?
+
+**Isolation.** A *slice* is a folder of Markdown cards you can mount, unmount and share
+independently. Mounted slices stay read-only through the engine; new learning goes into
+a separate overlay. Multiple workspaces can reuse the same baseline while keeping their
+own changes. Pending edits stay outside live memory until approved.
+
+**Evolving memory.** Cards can explicitly extend or supersede earlier knowledge, so
+retrieval follows recorded relationships under your trust rules. `bake` turns selected
+changes into new slice versions, preserving the original folders and returning the new paths.
+
+[Hot/cold memory](https://docs.letta.com/v1-sdk/memory/context-hierarchy) focuses on what stays
+in context and what is retrieved later. [LLM Wiki](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f)
+focuses on compiling sources into a maintained knowledge base. MindSlice makes **memory
+boundaries and controlled evolution** first-class engine operations.
+[How these approaches fit together →](docs/concepts.md)
+
+Python 3.12+. No runtime dependencies, database server or LLM API calls inside the engine.
+
+## Get started
+
+Paste this into your coding agent:
+
+```text
+Clone https://github.com/pancerZH/MindSlice.git (or use the existing checkout).
+Read skills/mindslice-setup/SKILL.md to finish setup.
+```
+
+The agent helps you choose a workspace, connect your app, and choose how to start:
+
+| Starting point | Tool |
+| --- | --- |
+| Empty memory or a short conversation | MindSlice `init` and ordinary memory writes |
+| Existing MindSlice workspace | Connect it directly with `-w` |
+| Shared `.slice` or Markdown notes folder | MindSlice `mount`, indexed as is |
+| Documents to distill into structured cards | [MindSlice-forge](https://github.com/pancerZH/MindSlice-forge) |
+
+Forge is an optional document-conversion tool. It creates a new workspace using an agent harness;
+MindSlice handles storage, retrieval, mounting and memory evolution without needing Forge or an LLM.
+The [builder skill](skills/slice-builder/SKILL.md) guides conversion and integration with an existing workspace.
+
+Prefer manual setup? With Python 3.12+ and pipx installed:
+
+```bash
+git clone https://github.com/pancerZH/MindSlice.git
+cd MindSlice
+pipx install -e .
+mindslice init ~/mindslice
+```
+
+Then [connect your agent](docs/getting-started.md#connect-your-agent) and tell it what to remember.
+Run `mindslice -w ~/mindslice doctor`, then [verify a new session](docs/getting-started.md#verify-your-first-session).
+[Full setup guide](docs/getting-started.md) · [Review changes and bake slices](docs/workflow.md)
+
+## Documentation
+
+- [Concepts](docs/concepts.md) — isolation, evolution, and how MindSlice fits other memory architectures.
+- [Reference](docs/reference.md) — commands, Python API, MCP tools and card formats.
+- [History and recovery](docs/history-and-recovery.md) — explain memory, roll back slices, back up and restore workspaces.
+- [Build slices with Forge](skills/slice-builder/SKILL.md) — convert documents and connect the resulting workspace or slices.
+- [Maintain memory](skills/slice-maintainer/SKILL.md) — consolidate knowledge and repair relationships.
+- [Evaluations](docs/evaluations.md) · [Design](docs/design.md) · [Uninstall](skills/mindslice-setup/uninstall.md)
+
+## License
+
+[Apache License 2.0](LICENSE). Benchmark excerpts quoted in the evaluation records keep their
+datasets' licences; see [NOTICE](NOTICE).

mindslice-0.1.0/mindslice/__init__.py

@@ -0,0 +1,58 @@
+"""MindSlice: a layered, pluggable, human-readable long-term memory engine for LLM agents.
+
+Plain Markdown + TOML on disk is the single source of truth; ``.cache/index.sqlite``
+is a disposable acceleration cache. Standard library only (Python 3.12+).
+
+    >>> from mindslice import Workspace
+    >>> ws = Workspace.init("workspace")
+    >>> ws.write("user-preferences/tooling", summary="The user prefers uv.", content="- Use `uv run` for scripts.")
+    >>> ws.search("uv scripts")["results"][0]["address"]
+    '@overlay/user-preferences/tooling'
+"""
+
+from .errors import (
+    AlreadyExistsError,
+    AmbiguousAddressError,
+    ApplyConflictError,
+    BakeConflictError,
+    FrontmatterError,
+    HistoryError,
+    InvalidAddressError,
+    InvalidArgumentsError,
+    LineageCycleError,
+    LockTimeoutError,
+    MindSliceError,
+    MountError,
+    NotFoundError,
+    PreconditionFailedError,
+    ReadOnlyMountError,
+    RecoveryError,
+    UnresolvedExportDependencyError,
+    WorkspaceNotFoundError,
+)
+from .workspace import Workspace
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Workspace",
+    "MindSliceError",
+    "AlreadyExistsError",
+    "AmbiguousAddressError",
+    "ApplyConflictError",
+    "BakeConflictError",
+    "FrontmatterError",
+    "HistoryError",
+    "InvalidAddressError",
+    "InvalidArgumentsError",
+    "LineageCycleError",
+    "LockTimeoutError",
+    "MountError",
+    "NotFoundError",
+    "PreconditionFailedError",
+    "ReadOnlyMountError",
+    "RecoveryError",
+    "UnresolvedExportDependencyError",
+    "WorkspaceNotFoundError",
+    "__version__",
+]

mindslice-0.1.0/mindslice/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .interfaces.cli import main
+
+sys.exit(main())

mindslice-0.1.0/mindslice/baking/__init__.py

@@ -0,0 +1 @@
+"""Slice preparation, reference transfer, batch planning and export."""

mindslice-0.1.0/mindslice/baking/archive.py

@@ -0,0 +1,66 @@
+"""Deterministic archives of a baked slice directory."""
+
+from __future__ import annotations
+
+import gzip
+import io
+import os
+import tarfile
+import tempfile
+import zipfile
+from pathlib import Path
+
+from ..storage.fsutil import fsync_dir
+
+
+def archive_format(output: Path) -> str:
+    name = output.name.lower()
+    if name.endswith(".zip"):
+        return "zip"
+    if name.endswith((".tar.gz", ".tgz")):
+        return "tar.gz"
+    return "directory"
+
+
+def write_archive(tree: Path, output: Path, fmt: str) -> None:
+    """Write all files, with fixed archive metadata, then atomically publish the archive."""
+    name = output.name
+    for suffix in (".tar.gz", ".tgz", ".zip"):
+        if name.lower().endswith(suffix):
+            name = name[:-len(suffix)]
+            break
+    root = name if name.endswith(".slice") else name + ".slice"
+    entries = [(root, None)]
+    entries += [(root + "/" + p.relative_to(tree).as_posix(), None if p.is_dir() else p.read_bytes())
+                for p in sorted(tree.rglob("*"))]
+    output.parent.mkdir(parents=True, exist_ok=True)
+    fd, temporary = tempfile.mkstemp(prefix=f".{output.name}.", dir=output.parent)
+    os.close(fd)
+    try:
+        if fmt == "zip":
+            with zipfile.ZipFile(temporary, "w", compression=zipfile.ZIP_DEFLATED) as archive:
+                for path, data in entries:
+                    info = zipfile.ZipInfo(path + "/" if data is None else path, date_time=(1980, 1, 1, 0, 0, 0))
+                    info.external_attr = ((0o40755 << 16) | 0x10) if data is None else 0o100644 << 16
+                    if data is not None:
+                        info.compress_type = zipfile.ZIP_DEFLATED
+                    archive.writestr(info, b"" if data is None else data)
+        else:
+            with open(temporary, "wb") as raw, gzip.GzipFile(filename="", mode="wb", fileobj=raw, mtime=0) as gz:
+                with tarfile.open(fileobj=gz, mode="w", format=tarfile.PAX_FORMAT) as archive:
+                    for path, data in entries:
+                        info = tarfile.TarInfo(path)
+                        info.mtime = 0
+                        info.uid = info.gid = 0
+                        info.uname = info.gname = ""
+                        info.mode = 0o755 if data is None else 0o644
+                        if data is None:
+                            info.type = tarfile.DIRTYPE
+                            archive.addfile(info)
+                        else:
+                            info.size = len(data)
+                            archive.addfile(info, io.BytesIO(data))
+        os.replace(temporary, output)
+        fsync_dir(output.parent)
+    finally:
+        Path(temporary).unlink(missing_ok=True)