JIXUDOCS
Packages

jixu-ai

Install the jixu command, reference TUI, and public application facade.

jixu-ai is the canonical package-manager entry point for the reference Jixu application. It installs the jixu executable and selects the matching native package for the current supported platform.

Install the command

npm install -g jixu-ai

Then start Jixu in the directory where the Agent should work:

jixu

For one-off execution, use npx jixu-ai, pnpm dlx jixu-ai, yarn dlx jixu-ai, or bunx jixu-ai.

What the package owns

  • the lifecycle-script-free launcher behind the jixu command;
  • the reference TUI and its configuration model;
  • the public Thread controller and TUI projection types;
  • the built-in Jixu theme and Tool configuration helpers; and
  • exact-version optional native packages for supported targets.

It does not introduce a second runtime. The TUI creates the same Agent, Harness, Thread, Event, and Driver path available through the Framework packages.

Public facade

Applications extending the reference experience can import the maintained facade surface:

import {
  createThreadController,
  DEFAULT_JIXU_TOOL_SETTINGS,
  JixuConfigStore,
  jixuTheme,
} from "jixu-ai";

Most Framework applications should depend on jixu-core and the required adapters directly rather than importing implementation details from the reference TUI.

Native distribution boundary

The launcher currently supports macOS arm64 and Linux x64 with glibc. It selects jixu-cli-darwin-arm64 or jixu-cli-linux-x64 as an exact-version optional dependency, then executes the bundled native artifact.

Do not install the platform package directly

Platform packages are transport artifacts, not alternate Jixu APIs. Installing jixu-ai keeps launcher metadata, native bytes, and the visible jixu command on the supported release path.

The package launcher requires Node.js 22.19.0 or newer. The selected standalone executable requires neither Node.js nor Bun at runtime.

Continue with the Reference TUI or Quick start.