JIXU DOCUMENTATION
Packages
Compose Jixu from independently installable runtime, adapter, Tool, and testing packages.
Jixu is a package family, not a monolithic SDK. Install the reference TUI as jixu-ai, or compose an application from jixu-core plus only the Drivers, Stores, Tools, and test support it needs.
Package map
| Package | Responsibility |
|---|---|
jixu-ai | Installable jixu command, configuration, public facade, and reference TUI |
jixu-core | Agent definition, Harness, Thread API, deterministic Kernel, ports, and in-memory Store |
jixu-llm | OpenAI Chat Completions and Anthropic Messages model Drivers |
jixu-store-jsonl | Inspectable local JSONL Event, Artifact, and Checkpoint Store |
jixu-store-sqlite | Local SQLite Event, Artifact, and Checkpoint Store |
jixu-tools-node | Opt-in file and local shell Tools for Node.js |
jixu-tools-jina | Bounded Jina Web Search and URL Reader Tools |
jixu-testkit | Deterministic clocks, IDs, Drivers, Signal capture, and Store contracts |
Every Framework package is independently published and can be installed directly from the npm registry.
Choose a composition
Smallest Harness
Core plus an LLM Driver. Threads remain in memory unless you provide a Store.
Durable local Agent
Add SQLite or JSONL so Events, Artifacts, and Checkpoints survive process restarts.
Local coding Tools
Add bounded file access and an explicitly disclosed unsandboxed shell.
Web evidence Tools
Add bounded Jina Search and Reader capabilities without placing credentials in Events.
Common stacks
Minimal Framework application:
npm install jixu-core jixu-llmDurable local application with first-party Tools:
npm install jixu-core jixu-llm jixu-store-sqlite jixu-tools-nodeContract-tested custom adapter:
npm install --save-dev jixu-core jixu-testkitNative CLI packages
jixu-cli-darwin-arm64 and jixu-cli-linux-x64 contain the platform executables selected by jixu-ai. They are exact-version optional dependencies and are not ordinary application dependencies. Install jixu-ai; do not select a native package manually.
Pre-1.0 package line
Package APIs and persisted schemas may change before 1.0. Keep Jixu packages on a compatible release line and review migration notes before upgrading durable Stores.