CLI

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.

InstallationCopy Anchor Link

npm install -g @risuko/cli

Or use Homebrew:

brew install yuemiyuki/risuko/risuko-cli

Or download standalone binaries from the download page or GitHub Releases.

UsageCopy Anchor Link

risuko <command> [options]

CommandsCopy Anchor Link

Global BehaviorCopy Anchor Link

• The CLI connects to the engine's JSON-RPC server (default port 16800); the exceptions are config, which reads and writes the local config files directly, and serve, which starts the engine itself
• If no engine is running, the download command starts a temporary headless engine on --rpc-port and stops it when the download finishes
• The CLI dials the rpc-host config value; a wildcard host (0.0.0.0, ::) is dialled as 127.0.0.1
• 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; if omitted, the CLI falls back to the rpc-secret value from system.json in the config directory (generated on first run, see RPC authentication)
• If the running engine rejects the secret, the CLI reports the authentication failure ("A Risuko instance is running but rejected the RPC secret…") instead of starting a second engine; pass the right --rpc-secret or check rpc-secret in system.json
• Use --json for machine-readable output on download, status, global-stat, files, peers, config list, and rss list; pause-all, resume-all, purge, and shutdown accept the flag but ignore it
• Errors print Error: <message> to stderr and exit with status 1; remove exits 0 even if some GIDs fail
• RUST_LOG overrides the log level