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.1.1.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.1.1-py3-none-any.whl (116.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: crabpath-2.1.1.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.1.1.tar.gz
Algorithm Hash digest
SHA256 f512485687b1bff02d86c197b4efb990eb112fee34739b0de6c982393c480485
MD5 ad7d28ce53027b140e5c1462b10fa38a
BLAKE2b-256 4570ce0127e38d6233631e932fdb036362798f7aa2e0cd89f9e1a5035cc81405

See more details on using hashes here.

Provenance

The following attestation bundles were made for crabpath-2.1.1.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.1.1-py3-none-any.whl.

File metadata

  • Download URL: crabpath-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 116.2 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f691bb52897f17dc3083e4704a722d9e166c0e0882cc270ff257f289f97bcbd4
MD5 7d4390b1717d1357c49cd5873dbff792
BLAKE2b-256 2e1c4d6298f39d9c0d2e19daaefe86c342f6c560cea96b6ca43622987a0c3d39

See more details on using hashes here.

Provenance

The following attestation bundles were made for crabpath-2.1.1-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