JIXU DOCUMENTATION
Introduction
A durable single-Agent Harness for TypeScript.
Jixu means continue in Chinese. It gives one Agent a durable Thread so work can survive a process exit, an interrupted provider request, or a deliberate pause without inventing another source of truth.
Pre-1.0
Jixu is actively evolving. Public APIs and stored-data compatibility may change before 1.0.
Documentation follows GitHub main
These pages describe the newest committed state of the Jixu repository. npm packages are release snapshots and may temporarily lag behind the APIs, TUI behavior, or package contracts documented here. The installed package version and its command catalogue remain the authority for that release.
The public promise
Define one immutable Agent, bind it to Stores and Drivers through a Harness, and continue its work through one durable Thread.
one Agent → one Harness → one durable ThreadThe ordered Event log is the sole authority for that Thread. State is derived, Checkpoints are disposable, and external work follows one explicit path:
Event → Reducer → Effect → Driver → EventThis makes recovery explainable. Jixu knows which work was requested, which outcome became durable, and which uncertain boundary requires a person instead of a blind retry.
Choose a path
Run the TUI
Install the native terminal interface and start a local Thread.
Build with the Framework
Create a Harness in TypeScript and provide your own Stores, Drivers, and Tools.
Coordinate long work
Use an adaptive Event-backed Plan without creating a second execution path.
Choose packages
Install only the runtime, Store, Driver, Tool, and test packages your Agent needs.
See what is next
Review planned capability areas without confusing them with shipped APIs.
Understand the model
Learn why Event authority and derived State make continuation safe.
Recover deliberately
Distinguish recovery, outcome resolution, Replay, and Fork before using them.
Designed for long-lived work
Jixu is intentionally small. It does not hide execution behind an opaque runtime. The important boundaries are named and inspectable:
- Inputs and external requests become durable before execution proceeds.
- Reducers are pure and perform no I/O.
- Replay reconstructs State without calling a live Driver.
- Unknown persisted data fails closed.
- Secrets never enter Events, State, Checkpoints, errors, or Signals.
- One Harness never routes work between Agents.
Continue with the Quick start, or begin with the Core model.