JIXU DOCUMENTATION
jixu-store-jsonl
An inspectable local JSONL Store for Events, Artifacts, and Checkpoints.
jixu-store-jsonl implements the EventStore port with ordinary local files. It is useful when direct inspection and simple filesystem backup matter more than a single database file.
Install
npm install jixu-core jixu-store-jsonlCreate the Store
import { JsonlEventStore } from "jixu-store-jsonl";
const store = new JsonlEventStore("./.jixu");Pass store to createHarness({ store, ... }).
On-disk layout
The configured directory contains three explicit surfaces:
threads/— one ordered JSONL Event file per Thread;artifacts/— immutable content-addressed Artifact bytes; andcheckpoints/— disposable projected-State caches.
Events remain the sole authority. Removing a Checkpoint may make recovery slower, but it must not change recovered State.
Store behavior
- Thread creation and Fork creation fail rather than publishing partial histories.
- appends use optimistic revision checks;
- Event IDs remain unique across Threads;
- persisted Events and Checkpoints are decoded fail-closed;
- Artifact bytes are verified against digest and byte length; and
- constructor-started validation remains visible to later Store operations.
Local Store boundary
This adapter is designed for inspectable local persistence. Do not infer distributed coordination or multi-process write guarantees from the JSONL format. A custom Store should implement the same port and pass the shared Store contract suite.
Compare jixu-store-sqlite when a single database file and transactional local writes are a better fit.