Skip to main content

Bobbin

This longform module page is the manufacturer-docs entry point for the module. It uses the product overview when that surface is admitted and falls back to the first safe versioned detail page when the overview is still blocked. Use it first; drop into the versioned product pages only when you need deeper surface detail or channel-specific reference.

  • Canonical module key: bobbin
  • Source repo: JaddaHelpifyr/jhf-bobbin
  • Preferred versioned channel today: stable

Versioned product docs​

Use these direct entry points when you need exact product behavior, operations, or reference detail:

Tool / Contract Summary​

jhf-bobbin is Helpifyr’s protected-knowledge operator module for OpenClaw memory enablement. It installs, re-applies, verifies, and packages a bounded Mem0 + LocalAI + Qdrant stack, while consuming Fabric-owned governance and claims truth read-only.

When You Need Bobbin​

Use jhf-bobbin when the stack needs a bounded operator kit for:

  • enabling semantic memory on top of OpenClaw
  • verifying LocalAI, Mem0, and Qdrant interoperability
  • exporting machine-readable status, drift, and package evidence
  • keeping memory enablement separate from policy or lifecycle ownership

Do not use jhf-bobbin as the owner for Fabric governance truth, host ingress, or a resident long-running application service.

Business Value​

  • keeps OpenClaw memory enablement reproducible instead of host-specific guesswork
  • separates runtime tooling from policy/lifecycle ownership
  • gives deployment and QA consumers machine-readable evidence instead of ad-hoc operator notes

Current Verified State​

  • canonical stack truth exists in configs/stack-contract.json
  • runtime, docs, packaging, and contract validators are repo-owned and wired into CI/selfcheck
  • support-summary and Dobby marked-provenance boundaries are contract-backed
  • Fabric governance, combination, JARVIS, and runtime-claims consumption is explicit and validator-backed

Available Now​

  • installer, reapply, rollback, smoke, and drift-detection scripts
  • metadata/status export and package artifact contract surfaces
  • machine-readable feature registry for QA and RC-readiness review

Optional / Extended​

  • optional live host probe evidence
  • optional live Fabric readback checks
  • optional low-CPU runtime profile

Planned / Not in Current Scope​

  • no public-admitted resident Bobbin API service; internal shadow-foundation runtime only
  • no Bobbin-owned policy or proposal lifecycle authority
  • no production-host mutation from default CI

Public Surfaces​

Contract Families​

Fabric-owned truth is consumed read-only. See:

  • Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
  • Memory Policy and Claims Consumption (docs/MEMORY_POLICY_AND_CLAIMS_CONSUMPTION.md)

Producer-/Consumer-Zuordnung​

  • Bobbin produces:
    • installer/reapply/verify tooling
    • package metadata
    • repo-local metadata and status exports
    • machine-readable QA feature inventory
  • Bobbin consumes:
    • OpenClaw runtime state
    • LocalAI and Qdrant runtime APIs
    • Fabric governance and claims truth
    • approved support summaries and marked Dobby artifacts

Ownership Boundary​

jhf-bobbin owns:

  • the Bobbin operator kit, scripts, and config artifacts
  • repo-owned drift, packaging, and metadata/status exports
  • memory enablement documentation and QA feature truth in this repository

jhf-bobbin does not own:

  • the live runtime host or default runtime mutation lane
  • Fabric policy, claims, or lifecycle authority
  • ingress, publisher, or jhf-docs materialization ownership
  • Dobby or support-domain source truth outside the documented contracts

Compatibility Window​

  • version truth: v0.x.y or derived 0.0.0+<shortsha>
  • runtime reference platform: Linux
  • host verification remains operator-run outside baseline CI

Lifecycle Status​

  • module state: active
  • delivery posture: operator kit
  • maturity: RC-readiness preparation, no RC created in this run

Readiness / Drift / Monitoring​

  • repo-local readiness:
    • bash scripts/fabric-selfcheck.sh
    • python3 scripts/check_docs_contract.py
    • python3 scripts/check_module_features_contract.py
  • live/runtime drift:
    • python3 scripts/check_live_runtime_contract.py
    • python3 scripts/export_host_runtime_snapshot.py

Deployment / Verify​

bash scripts/bootstrap.sh
bash scripts/install_jhf_memory.sh
bash scripts/fabric-selfcheck.sh
python3 scripts/check_docs_contract.py
python3 scripts/check_module_features_contract.py

For a docs/source-contract-only verification pass, run:

python3 scripts/check_docs_contract.py
python3 scripts/check_module_features_contract.py
python3 scripts/export-fabric-metadata.py

Docs Platform v1.6 Baseline​

The canonical base docs family for this repository is:

  • README.md
  • docs/OVERVIEW.md
  • docs/INSTALL.md
  • docs/CONFIGURATION.md
  • docs/OPERATIONS.md
  • docs/TROUBLESHOOTING.md
  • docs/RELEASE_NOTES.md
  • docs_manifest.yml

These pages provide the repo-owned foundation for docs inventory, capability coverage, rollback readiness, and execution-link posture.

Known Limits​

  • host-specific runtime evidence still depends on operator access
  • community plugin drift remains an upstream compatibility risk
  • some end-to-end producer/consumer tests remain cross-repo by nature
  • JaddaHelpifyr/jhf-bobbin#60
  • JaddaHelpifyr/jhf-bobbin#69
  • JaddaHelpifyr/jhf-bobbin#74

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.