Skip to main content

🦀 Memory store for AI agents that learns what to retrieve — and what to suppress — from experience.

Project description

🦀 CrabPath

CrabPath is a memory store for AI agents that learns what to retrieve — and what to suppress — from experience.

Why?

  • Static context loading wastes tokens because you load too much every turn.
  • Classic RAG can’t learn from feedback, so retrieval stays similarity-only.
  • CrabPath tracks which retrieval paths worked, and builds a graph of learned routes.

Install

python3 -m venv ~/.crabpath-env && source ~/.crabpath-env/bin/activate
pip install crabpath            # PyPI
clawhub install crabpath        # or ClawHub (OpenClaw agents)

# For embeddings (strongly recommended):
pip install crabpath[openai]     # or: pip install crabpath[google]

Zero required dependencies. Python 3.10+. macOS Homebrew Python needs a venv (PEP 668).

Quick Start (60 seconds)

from crabpath import Node, Edge, Graph, activate, learn

g = Graph()
g.add_node(Node("timeout", "Deployment timed out"))
g.add_node(Node("rollback", "Rollback and restore"))
g.add_node(Node("debug", "Inspect logs"))
g.add_edge(Edge("timeout", "rollback", 0.6))
g.add_edge(Edge("timeout", "debug", 0.4))

result = activate(g, seeds={"timeout": 1.0})
learn(g, result, outcome=1.0)  # reinforces paths that fired
print([node.id for node, energy in result.fired])

For AI Agents (3 commands)

crabpath init --workspace ~/.openclaw/workspace --sessions ~/.openclaw/agents/main/sessions/
crabpath install-hook --agent-workspace ~/.openclaw/workspace
crabpath query 'how do I deploy' --graph ~/.crabpath/graph.json --index ~/.crabpath/embed.json --top 8 --json

Which Interface?

Interface Status / Use
CLI (agents) Primary agent-facing interface; JSON I/O for shell workflows.
MemoryController (Python) Recommended direct integration for Python apps.
Adapter Deprecated legacy bridge; prefer CLI or MemoryController.

How It Works

  • Documents are split into nodes and edges become weighted pointers.
  • Reflex edges (>0.8) auto-follow with near-zero overhead.
  • Habitual edges (0.3-0.8) go through normal routing policy.
  • Dormant edges (<0.3) are suppressed by default.
  • Positive outcomes (+1) strengthen paths; negative outcomes (-1) create inhibitory edges.
  • Decay drops unused connections, while the autotuner keeps graph routing healthy.

Key Results

Metric Result
Context reduction 90-99%
Negation accuracy 1.0 vs 0.0 (BM25)
Internal tests 360
Required deps Zero

Full benchmark details: docs/research/

When NOT to Use CrabPath

  • Simple static-document RAG without feedback loops (use a vector DB).
  • Very small codebases (< 10 files) with insufficient structure to learn recurring routes.
  • One-off questions with no recurring retrieval patterns.

Links

License

Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crabpath-2.2.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crabpath-2.2.0-py3-none-any.whl (117.5 kB view details)

Uploaded Python 3

File details

Details for the file crabpath-2.2.0.tar.gz.

File metadata

  • Download URL: crabpath-2.2.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for crabpath-2.2.0.tar.gz
Algorithm Hash digest
SHA256 951612da08aa5028918e1b7ca9f94b2285a519868efe4d94f217a7e79ed718fb
MD5 475886dcd727af41000ba0aa5114240b
BLAKE2b-256 e22440b60c89b7b06e87f6b865b491a60b7cc34a97d2c9a84b521d4172b741aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for crabpath-2.2.0.tar.gz:

Publisher: publish.yml on jonathangu/crabpath

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crabpath-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: crabpath-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 117.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for crabpath-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2fe1ef4b383dc93f9b9f41fe3b6dcb8b8758897d9003cde81ab8af374a6bac4
MD5 1ff02fa3c624f685968b0e09f1baffcb
BLAKE2b-256 7906dad1764efa38ea14fea0c376d0b476e6375cef5891a435cd70a5758f4046

See more details on using hashes here.

Provenance

The following attestation bundles were made for crabpath-2.2.0-py3-none-any.whl:

Publisher: publish.yml on jonathangu/crabpath

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page