Overview
Install Kunai, operate the shell, recover streams, manage offline media, and understand privacy boundaries.
Kunai documentation
Everything you need to install Kunai, operate the shell daily, and recover when providers or networks misbehave.
Pages describe observable behavior in the current beta CLI, including what is local-only, cached, opt-in, or live-provider backed.
Beta scope (read this first)
install.sh / install.ps1 (self-contained binary — Bun runtime embedded; you do not need Bun). Bun/npm globals are secondary; npm requires Bun on PATH. You still need mpv for playback — setup and browsing work without it. Kunai does not host media - it resolves streams from third-party providers on your machine and hands playback to mpv. Provider availability changes; recovery commands exist because drift is expected.Pick your path
First run
Set up Kunai
Install once, verify Bun and mpv, then learn the launch flags that actually change bootstrap behavior.
Getting started
The fastest honest path from zero to a first successful playback session.
Install And Update
Global package, source checkout, installer script, and manual update checks.
Platforms
Linux, macOS, Windows, and source-checkout notes with optional tool guidance.
Customization
Config, provider overrides, mpv forwarding, themes, and presence setup.
Supported And Unsupported
What Kunai ships today, what is beta-only, and what is explicitly out of scope.
Daily use
Watch and navigate
How search, shell commands, playback handoff, and continuation fit together in one session.
What you can do
Concrete scenarios: search, play, recover, continue, discover, and export diagnostics.
Share Links
Copy and open catalog-anchored kunai:// links across machines and providers.
Feature Tour
Capability map with live command and provider tables from the registry.
Commands And Shortcuts
Palette commands, playback actions, overlays, and reporting shortcuts.
Playback And Recovery
Recover, replay, resume, fallback, and what each action actually does.
Continue Watching
History continuation, auto-advance, and queue behavior after playback.
Media Selection
Seasons, episodes, subtitles, qualities, and provider picking in the shell.
Runtime Feedback
Loading states, toasts, overlays, and how Kunai explains slow paths.
Providers
How provider fallback works, what retry means, and what Kunai does not guarantee.
Troubleshooting
Symptom-indexed fixes with evidence to collect before filing an issue.
Local media
Downloads and offline
Separate download-only launch from in-shell queue management — they are not the same entry point.
Trust
Reliability and privacy
What Kunai stores locally, what stays in cache, and what never belongs in a support bundle.
Truth boundaries
Privacy by default
Two download entry points
kunai --download -S "Title" is a download-only bootstrap: resolve the title, queue downloads, exit - no shell queue UI. /downloads inside the running shell manages queued, running, and failed jobs. Do not confuse them.Generated reference
The CLI reference and Feature tour embed tables synced from the running CLI registry. Re-run bun run --cwd apps/docs generate after changing commands or providers.
Last updated on