Installation

Risuko distributes platform-specific binaries via npm. No Rust toolchain or native compilation is needed at install time.

CLI

Install the @risuko/cli package globally:

npm install -g @risuko/cli

or, use Homebrew

# CLI
brew install yuemiyuki/risuko/risuko-cli

This installs the risuko binary. Verify it works:

risuko --version

Supported Platforms

The correct platform package is automatically selected via optionalDependencies.

Standalone Binaries

Pre-built binaries are also available on the GitHub Releases page. Download the archive for your platform and add it to your PATH.

Node.js API

Install the @risuko/risuko-js package:

npm install @risuko/risuko-js

This provides native Node.js bindings with full TypeScript definitions.

Supported Platforms

Requirements

• Node.js 18 or later
• One of the supported platforms listed above

Desktop App

Download the latest release from GitHub Releases:

• macOS: .dmg (Universal or per-architecture)
• Linux: .deb, .rpm, or .AppImage
• Windows: .msi or .exe installer

Linux: WebKitGTK rendering

On Linux, Risuko sets WEBKIT_DISABLE_DMABUF_RENDERER=1 and WEBKIT_DISABLE_COMPOSITING_MODE=1 at startup when these variables are not already defined in the environment. This works around a WebKitGTK 2.42+ crash on NVIDIA, virtualized GPUs, and Wayland sessions without a working GBM backend (Could not create GBM EGL display: EGL_NOT_INITIALIZED. Aborting... followed by SIGABRT before the window is shown). Export either variable yourself before launching Risuko if you need to override the default.

Use App launcher

Install @risuko/app globally:

npm install -g @risuko/app

Then run:

risuko-app

or, use Homebrew

# App launcher
brew install --cask yuemiyuki/risuko/risuko-app

Building from Source

If you need to build Risuko yourself:

# Clone the repository
git clone https://github.com/YueMiyuki/risuko.git
cd risuko

# Install frontend dependencies
pnpm install

# Build the CLI only
cd src-tauri
cargo build --release -p risuko-cli

# Build the full desktop app
pnpm tauri build

Build Requirements

• Rust 1.75+ (stable)
• Node.js 18+
• pnpm 10+
• Platform-specific dependencies (see Tauri prerequisites)