Quick start

Install the terminal interface

npm install -g jixu-ai
jixu

Or run it without a global installation:

npx jixu-ai

Run the latest source

The GitHub main branch is Jixu's newest committed development state. It may contain fixes, package changes, or TUI work that has not reached the npm release yet.

git clone https://github.com/joe960913/Jixu.git
cd Jixu
pnpm install --frozen-lockfile
pnpm dev

The source checkout uses pnpm 11 for the workspace and Bun to launch the development TUI. It requires Node.js 22.19.0 or newer, pnpm, and Bun.

The package launcher requires Node.js 22.19.0 or newer. The native TUI currently supports macOS arm64 and Linux x64 with glibc. Intel macOS is not supported. Bun is not required on the target machine at runtime.

Configure a model

Open Jixu in the directory where the Agent should work, then enter:

/config

Choose an API format, Base URL, model, and Key. Jixu keeps BYOK configuration in ~/.jixu/settings.json. The active Agent snapshot is immutable, so accepted configuration applies to a newly constructed Harness and Thread rather than mutating an existing one.

Send the first request

Type an ordinary request in the Composer. Jixu creates or selects a Thread, appends the input, and advances the Agent through the same durable execution path used by the Framework.

Useful first commands:

Install the Framework

npm install jixu-core jixu-llm jixu-store-sqlite

Then follow Framework setup to define an Agent, connect a Driver, and create a durable Thread.