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.

Two Modes

Mode What you get What you need
Full Learned routing + inhibition + decay. The graph gets smarter over time. Any OpenAI-compatible LLM endpoint
Retrieval-only Semantic search over your workspace. Better than nothing, but just RAG with extra steps. Nothing (works out of the box)

CrabPath always works. But the magic — learning what NOT to retrieve — requires a real LLM.

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).

LLM Access (for full mode)

For the real experience, CrabPath's smart routing needs a real LLM. Without one, it falls back to retrieval-only (like RAG). Provide access via any of:

# Option 1: Direct API key (easiest)
export OPENAI_API_KEY=sk-...          # also checks ~/.env automatically

# Option 2: Any OpenAI-compatible endpoint (most flexible)
export CRABPATH_LLM_URL=http://localhost:8080/v1/chat/completions
export CRABPATH_EMBEDDINGS_URL=http://localhost:8080/v1/embeddings
export CRABPATH_LLM_TOKEN=your-token  # if endpoint needs auth

# Option 3: Local Ollama (free, private)
ollama pull nomic-embed-text          # embeddings
ollama pull llama3                     # routing

Works with: OpenAI, Gemini, Ollama, LiteLLM, vLLM, OpenRouter — anything OpenAI-compatible.

Without LLM access, CrabPath still works using local TF-IDF embeddings and heuristic routing — but you're missing the learned routing that makes it better than RAG.

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.4.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.4.0-py3-none-any.whl (121.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: crabpath-2.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 5e2ad4a3dc99746d8162a32044f9a012d860fb553b6ee1f2a17e37931f0ad9d7
MD5 ac01c990d421a950922f8e9bdda765d2
BLAKE2b-256 f3e9ffde46011664cf4b40c5154fa9e134a04194f7d09e27b4e73ec280d109bd

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: crabpath-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 121.0 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 726631073b29053adf3d998a7dd3f0fc8b6553b0ace051a553a44768521d6b56
MD5 2390920432d9f5b7efa57e76360064d9
BLAKE2b-256 d81850b36d72d4454061258ef2ea0777628a330520b21faa8813d67534b93986

See more details on using hashes here.

Provenance

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