rk setup

Summary

Install and verify required development tools.

Description

Supported tools: squashfs-tools, which creates squashfs filesystems and is required for production builds. On macOS it installs with Homebrew; on Linux it uses apt-get, dnf, yum or pacman (auto-detected); on Windows installation is manual. --install-cli installs a small script at ~/.local/bin/rk that resolves the nearest project-local rk and runs it directly, skipping the npx/pnpm wrapper overhead. If ~/.local/bin is not on your PATH, instructions are printed after install. The launcher is not supported on native Windows (cmd/PowerShell); use node_modules.bin on PATH instead. Git Bash, MSYS2 and MinGW shells are supported.

Usage

rk setup [options]

Options

Flag	Value/type	Required
`--check`	boolean	no
`--install-cli`	boolean	no
`--uninstall-cli`	boolean	no
`--force`	boolean	no

--check

Only check if tools are installed (don't install)

--install-cli

Install a global 'rk' launcher so you can run 'rk <command>' directly (no npx/pnpm prefix) for faster startup

--uninstall-cli

Remove the global 'rk' launcher created by --install-cli

--force

With --install-cli, overwrite an existing unmanaged 'rk' file

Examples

rk setup
rk setup --check
rk setup --install-cli
rk setup --uninstall-cli