Skip to content

README.md

Latest commit

 

History

History
107 lines (80 loc) · 4.66 KB

README.md

File metadata and controls

107 lines (80 loc) · 4.66 KB
Raw

MOOT Memory

MOOT Memory provides standalone memory, vector, and retrieval engines from the MOOTx01 Framework.

Current version: v1.0.37 · generated from canonical source commit 1ea9e910e.

Choose this repository when: You need a structured memory estate, vector search, or a private local RAG engine. This is the usual starting repository for product builders.

Documentation index · package map · dependency graph · security policy

Open-source SDK family

The MOOTx01 engines are published as four standalone Apache-2.0 repositories. You can install one repository or compose the family.

Repository Use it for
moot-memory Structured memory, vector search, and local RAG
moot-semantics ARIA vocabulary and deterministic local classification
moot-system Storage, datasets, queues, sync, telemetry, and loopback HTTP
moot-core Shared types, kernel, fingerprints, lifecycle rules, and memory math

Dependency order is moot-core, then moot-semantics and moot-system, then moot-memory. The release tags move in lockstep.

Packages

Package Responsibility Swift product Rust crate
LocusKit Structured estate memory, knowledge graph, audit, and recall LocusKit locus-kit
VectorKit Durable on-device vector and fingerprint search VectorKit vectorkit
CorpusKit Chunking, BM25, embeddings, and hybrid local RAG CorpusKit and CorpusKitProviders corpus-kit and corpus-kit-providers

Start with LocusKit for structured memory, VectorKit for similarity search, or CorpusKit for a complete text retrieval engine.

Add it to a project

The Swift package requires Swift 6.2 and declares macOS 26 and iOS 26. Add the repository, then select only the products your target uses.

dependencies: [
    .package(
        url: "https://github.com/codedaptive/moot-memory.git",
        from: "1.0.37"
    ),
],
targets: [
    .target(
        name: "YourTarget",
        dependencies: [
            .product(
                name: "LocusKit",
                package: "moot-memory"
            ),
        ]
    ),
]

The Rust workspace uses edition 2021. Select a concrete crate by package name.

[dependencies]
locus-kit = { git = "https://github.com/codedaptive/moot-memory", tag = "v1.0.37" }

Verify a checkout with both language gates:

swift test
cargo test --workspace --locked

Documentation

docs/README.md is the documentation front door. Each package has three maintained views:

Use docs/CONFORMANCE.md for cross-language gates. Use docs/DATA_PROVENANCE.md for artifact origin. Use SOURCE.md and docs/PUBLISH_REPORT.md to trace this release back to the canonical source.

What This Repository Is

This repository is a generated public venue for MOOTx01 Framework libraries. The code here is Apache-2.0 and is intended for direct use outside the MOOTx01 product. The publisher records the exact source and load report for every tag.

  • Canonical source: mootx01-ee
  • Source commit: 1ea9e910eb626806f4452aef03d063c04b60c82a
  • Version: 1.0.37
  • Generated by: scripts/lib_publish/publish-libraries.py

See CONTRIBUTING.md before proposing changes and SECURITY.md for private vulnerability reporting.

MOOTx01 is a registered trademark. Use MOOTx01 Approved only for artifacts that pass the published conformance and release gates. Independent work that has not passed those gates should use compatible with MOOTx01 technology.