Installation

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

CLICopy Anchor Link

Install the @risuko/cli package globally:

npm install -g @risuko/cli

or, use Homebrew (macOS and Linux)

# CLI
brew install yuemiyuki/risuko/risuko-cli

This installs the risuko binary. Verify it works:

risuko --version

Supported PlatformsCopy Anchor Link

The correct platform package is automatically selected via optionalDependencies.

Standalone BinariesCopy Anchor Link

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

• risuko-cli-darwin-arm64.tar.gz, risuko-cli-darwin-x64.tar.gz
• risuko-cli-linux-x64.tar.gz, risuko-cli-linux-arm64.tar.gz
• risuko-cli-win32-x64.zip

Windows arm64 is available via npm only.

Node.js APICopy Anchor Link

Install the @risuko/risuko-js package:

npm install @risuko/risuko-js

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

Supported PlatformsCopy Anchor Link

RequirementsCopy Anchor Link

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

Desktop AppCopy Anchor Link

Download the latest release from the download page, which serves every build from a Cloudflare mirror, or from GitHub Releases:

• macOS: .dmg (Intel and Apple Silicon)
• macOS (Homebrew): brew install --cask yuemiyuki/risuko/risuko-app
• Linux: .deb, .rpm, or .AppImage
• Windows (x64 and x86): .setup.exe (NSIS installer, per-user) or .portable.exe (no install)
• Android: .apk (per-ABI builds)

Tagged desktop releases can include Tauri updater artifacts. The app checks the Risuko update endpoint for the current target/architecture/version and verifies the signed updater payload before installing it. Automatic update checks are disabled by default on every platform; enable auto-check-update from Preferences or user.json to opt in.

Linux: WebKitGTK renderingCopy Anchor Link

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 launcherCopy Anchor Link

Install @risuko/app globally:

npm install -g @risuko/app

Then run:

risuko-app

Each launch checks for the latest release. If it is not cached yet, the launcher downloads the desktop app for your platform from the Cloudflare mirror (falling back to GitHub Releases), verifies its release signature, and caches it per version; otherwise it launches the cached copy. When the check fails, for example offline, it launches the newest cached version. Use --version <x.y.z> to pin a specific release and --no-cache to force a re-download. Requires Node.js 22 or later.

Building from SourceCopy Anchor Link

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
cd ..

# Build the full desktop app (adds the per-platform Tauri config)
pnpm build

Build RequirementsCopy Anchor Link

• Rust 1.85+ (stable)
• Node.js 22+
• pnpm 11+
• Platform-specific dependencies (see Tauri prerequisites)