Platforms

Recommended install (self-contained binary — Bun runtime embedded; you do not need Bun installed):

curl -fsSL https://raw.githubusercontent.com/KitsuneKode/kunai/main/install.sh | bash
kunai --version
mpv --version
kunai --setup

Package install alternative (requires Bun):

bun install -g @kitsunekode/kunai
# or: npm install -g @kitsunekode/kunai
kunai --setup

Recommended optional tools:

• mpv — playback engine (required for watching; setup/browsing work without it)
• yt-dlp — offline download jobs and YouTube playback
• ffprobe — optional validation of completed artifacts
• xdg-open — /docs, /report-issue, folder reveal, and account auth handoffs

Alpine and other musl hosts use the kunai-linux-*-musl release assets. install.sh selects musl automatically when the host libc is musl.

apk add mpv yt-dlp ffmpeg
curl -fsSL https://raw.githubusercontent.com/KitsuneKode/kunai/main/install.sh | bash
kunai --version
kunai --setup

Ensure ~/.local/bin is on your shell PATH after install. Treat this as a normal Linux environment — not a Windows PATH.

Recommended install (beta binaries):

curl -fsSL https://raw.githubusercontent.com/KitsuneKode/kunai/main/install.sh | bash
kunai --setup

Package install alternative:

bun install -g @kitsunekode/kunai
kunai --setup

Install mpv and optional download tools through Homebrew or your preferred package manager. Kunai uses open for browser and folder handoffs. Protocol registration is Linux-only — use kunai --open for share links. Unsigned binaries may need quarantine cleared — see Install and update.

Recommended install (PowerShell; x64 beta, ARM64 experimental):

irm https://raw.githubusercontent.com/KitsuneKode/kunai/main/install.ps1 | iex
kunai --setup

Kunai runs where a capable terminal and native Windows mpv.exe are available on the same PATH as Kunai. Windows Terminal is the most predictable surface.

Kunai uses cmd /c start for browser handoffs such as /docs and /report-issue. If an opener is missing, the shell should keep running and explain the limitation. Protocol registration is Linux-only — use kunai --open for share links.

Do not mix this with a WSL install: Windows-native Kunai cannot use WSL mpv, WSL PATH entries, or Linux config/data directories.

WSL is a Linux environment. Install the Linux binary and Linux tools inside the distro — do not expect Windows-native kunai.exe / mpv.exe / %APPDATA% to apply.

# Inside WSL (Ubuntu/Debian example)
sudo apt install mpv yt-dlp ffmpeg
curl -fsSL https://raw.githubusercontent.com/KitsuneKode/kunai/main/install.sh | bash
kunai --version
kunai --setup

On Alpine WSL, use the Alpine recipe instead (apk add …). Config and data live under the Linux home (~/.config/kunai, ~/.local/share/kunai), separate from any Windows-native install.

Contributor-oriented:

bun install
bun run dev
bun run dev -- -S "Dune"
bun run dev -- -a -S "Attack on Titan"

Source checkouts are the best path for debugging provider changes, playback recovery, and documentation contributions — not the preferred end-user install. BSD hosts without a published binary should use this path (or npm/bun global), not install.sh.