Skip to content

Install LightRSI

This page covers the LightRSI platform installation — the shared runtime that all plugins need. After this, install your first plugin (e.g., TokenPilot).

Prerequisites

RequirementMinimumNotes
Node.js≥ 18v20+ recommended
pnpm≥ 9v10.32+ used in development
OSmacOS, Linux, Windows (WSL)Windows native may work but is less tested
Target HostOpenClaw / Codex / Claude CodeAt least one must be installed

No cloud services, API keys, or external dependencies are required.

Step 1: Clone the Repository

bash
git clone https://github.com/zjunlp/LightRSI.git
cd LightRSI

Step 2: Enable Corepack and Install

bash
corepack enable
pnpm install

This installs all workspace dependencies across the plugin packages and host adapters.

Step 3: Build Shared Packages

bash
pnpm build

This builds the shared packages (runtime-core, kernel, layers, host-adapter) that all plugins and adapters depend on.

Step 4: Build and Install the CLI

bash
pnpm lightrsi:build
pnpm lightrsi:install

The first command builds the shared lightrsi CLI. The second installs it to ~/.local/bin/lightrsi.

PATH notice Make sure ~/.local/bin is on your PATH. Add this to your shell config if needed:

bash
export PATH="$HOME/.local/bin:$PATH"

Verify Installation

bash
lightrsi --help

You should see the top-level command listing.

bash
lightrsi context

This shows your current default host, pinned session, and config target.

What Got Installed

ComponentLocationPurpose
lightrsi CLI~/.local/bin/lightrsiStandalone CLI for all hosts
Shared packagesnode_modules/ (workspace)Runtime engine, types, contracts
Host adapter codecomponents/tokenpilot/adapters/Per-host integration code

Next

Released under the MIT License.