Skip to main content

Memory graph for AI agents that learns what to retrieve — and what to suppress.

Project description

CrabPath

Pure routing graph engine for context-aware retrieval. Core is zero dependencies and zero network; the caller supplies semantic and LLM callbacks.

1. CrabPath

CrabPath v8.0.0 is a deterministic graph engine that builds traversable context graphs and improves routing from feedback, without any external service requirement by default.

2. Design Tenets

  • No network calls in core (not even for model downloads)
  • No secret discovery (no dotfiles, no keychain, no env probing)
  • No subprocess provider wrappers
  • Embedder identity stored in state metadata (name, dim, schema_version); hard-fail on dimension mismatch
  • One canonical state format (state.json)

3. Install

pip install crabpath
clawhub install crabpath         # ClawHub (for OpenClaw agents)

4. Quick Start (out of the box)

from crabpath import split_workspace, traverse, apply_outcome, VectorIndex, HashEmbedder

embedder = HashEmbedder()  # default hash-v1 (1024-dim)
graph, texts = split_workspace("./workspace")
index = VectorIndex()

for nid, content in texts.items():
    index.upsert(nid, embedder.embed(content))

query_vec = embedder.embed("how do I deploy to production?")
seeds = index.search(query_vec, top_k=8)
result = traverse(graph, seeds)
apply_outcome(graph, result.fired, outcome=1.0)

5. Real Embeddings via Caller Callbacks

from openai import OpenAI
from crabpath import split_workspace, VectorIndex
from crabpath._batch import batch_or_single_embed

client = OpenAI()

def embed_batch_fn(items):
    ids, contents = zip(*items)
    resp = client.embeddings.create(model="text-embedding-3-small", input=list(contents))
    vectors = {ids[i]: resp.data[i].embedding for i in range(len(ids))}
    if any(len(v) != 1536 for v in vectors.values()):
        raise ValueError("dimension mismatch: expected 1536")
    return vectors

graph, texts = split_workspace("./workspace")
index = VectorIndex()
vecs = batch_or_single_embed(list(texts.items()), embed_batch_fn=embed_batch_fn)
for nid, vec in vecs.items():
    index.upsert(nid, vec)

6. LLM Callbacks

from openai import OpenAI
from crabpath import split_workspace

client = OpenAI()

def llm_fn(system, user):
    resp = client.chat.completions.create(
        model="gpt-5-mini",
        messages=[{"role": "system", "content": system}, {"role": "user", "content": user}],
    )
    return resp.choices[0].message.content

# Pass to split for LLM chunking, or to query routes as needed
graph, texts = split_workspace("./workspace", llm_fn=llm_fn)

7. Session Replay (prominent)

Session replay is core in v8 and is the fastest way to warm-start a new brain from history.

from crabpath import replay_queries, split_workspace
from crabpath.replay import extract_queries_from_dir

graph, texts = split_workspace("./workspace")
queries = extract_queries_from_dir("./sessions/")
replay_queries(graph=graph, queries=queries)

Or via CLI:

crabpath init --workspace ./ws --output ./data --sessions ./sessions/
crabpath replay --state ./data/state.json --sessions ./sessions/

8. Three Embedding Tiers

Tier Capability Network Notes
1 Default hash-v1 none Built into core, zero deps, deterministic baseline
2 Semantic callback optional Caller-provided embed_fn / embed_batch_fn (OpenAI, Gemini, local service, etc.)
3 Replay none No new embedding calls; uses historical query signals and graph traversal history

9. Benchmarks

Benchmark results are commit-specific and should be regenerated locally:

Run python3 benchmarks/run_benchmark.py to see current deterministic results for this commit.

10. CLI

--state is the preferred API; --graph/--index are legacy compatibility flags.

crabpath init --workspace W --output O [--sessions S]
crabpath query TEXT --state S [--top N] [--json]
crabpath learn --state S --outcome N --fired-ids a,b,c
crabpath health --state S
crabpath doctor --state S
crabpath info --state S|--graph G
crabpath replay --state S --sessions S
crabpath merge --state S
crabpath connect --state S
crabpath journal [--stats]

# Legacy
crabpath query TEXT --graph G [--index I] [--query-vector-stdin] [--top N] [--json]
crabpath learn --graph G --outcome N --fired-ids a,b,c [--json]
crabpath replay --graph G --sessions S
crabpath health --graph G
crabpath merge --graph G
crabpath connect --graph G

11. Reproduce Results

See REPRODUCE.md.

12. Paper

https://jonathangu.com/crabpath/

13. Status

  • 8 deterministic simulations: all PASS
  • 150 tests
  • Production: 3 agent brains using real OpenAI embeddings

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-9.1.0.tar.gz (71.0 kB view details)

Uploaded Source

Built Distribution

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

crabpath-9.1.0-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crabpath-9.1.0.tar.gz
Algorithm Hash digest
SHA256 95dbbe076273ece90ae6ccf8e9cf93b550b56e26943988e91c7b63ecdcdad8f4
MD5 51ec7c40e61570f743881e063fe698bf
BLAKE2b-256 3ce2a40ebd50dc250b887e5095c3bf10f7df0767e1185eadc10134be0e8420dd

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: crabpath-9.1.0-py3-none-any.whl
  • Upload date:
  • Size: 45.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-9.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 666ec51e2ce850e851cfb8fc1b0dfc153537aa350ebaddc7c99e64acafa7a43e
MD5 6bae41e5d740e88f8fb9d85227e3e8ed
BLAKE2b-256 4fbba3ff33666201487e8146f49a81c4376dced727aff940a4059e916c56c54f

See more details on using hashes here.

Provenance

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