Risuko
CLI

CLI

Risuko command-line interface reference.

The Risuko CLI (risuko) is a standalone binary that provides full access to the download engine from your terminal. It communicates with a running engine instance via JSON-RPC, or starts a temporary headless engine when needed.

Installation

npm install -g @risuko/cli

Or download standalone binaries from GitHub Releases.

Usage

risuko <command> [options]

Commands

CommandDescription
downloadDownload a file from a URL, magnet link, or torrent file
statusShow status of downloads
pausePause a download
resumeResume a paused download
removeRemove a download
pause-allPause all active downloads
resume-allResume all paused downloads
global-statShow global download/upload stats
filesShow files belonging to a download
peersShow peers for a torrent download
purgePurge completed/error/removed results
configGet, set, or list configuration values
rssManage RSS feed subscriptions
serveStart headless engine (RPC server only)
shutdownRequest engine shutdown via RPC

Global Behavior

  • The CLI connects to the engine's JSON-RPC server (default port 16800)
  • If no engine is running, the download command starts a temporary headless instance
  • Use --rpc-port on most commands to connect to a non-default port
  • Use --rpc-secret to pass an authentication token when the engine has rpc-secret configured
  • Use --json for machine-readable output

Command Reference

Examples

Quick Start

Get up and running with Risuko in minutes.

Command Reference

Detailed reference for all Risuko CLI commands.

On this page

Installation
Usage
Commands
Global Behavior