Documentation
Install Kunai, learn the terminal shell, recover playback, and contribute with evidence-first debugging.
Kunai is a terminal-first media shell: search, resolve direct-provider streams locally, supervise mpv, and recover when catalogs drift. This documentation states what works today, what is beta-only, and how to debug with evidence.
I want to…
| Goal | Start here |
|---|---|
| Install Kunai and run first playback | Getting started |
| See everything Kunai can do | What you can do |
| Understand beta scope and limits | Supported and unsupported |
| Fix provider or playback failures | Troubleshooting |
| Tune providers, mpv, and presence | Customization |
| Understand fallback and recovery | Providers · Playback and recovery |
| Export diagnostics for a bug report | Diagnostics and reporting |
| Manage offline downloads | Downloads and offline |
| Contribute code or docs | Contribute |
| Debug as a developer | Debugging workflow |
Start here
User guides
Install Kunai, learn the shell, recover playback, manage offline media, and read privacy boundaries.
Developer
Debug sessions with evidence, run live smokes safely, and keep documentation aligned with the CLI.
CLI reference
Launch flags, provider registry, and command tables synced from the running CLI.
Getting started
The fastest honest path from zero to a first successful playback session.
Recommended reading order
Install and verify
Read Getting started, then Platforms for OS-specific tools. Binary installs via install.sh / install.ps1 are beta supported - see Install and update.
Learn the shell
Use What you can do for the capability map, the Feature tour for live command/provider tables, and Commands and shortcuts for daily palette work.
Plan for failure
Playback and recovery and Providers explain recover vs fallback. Troubleshooting indexes common symptoms. Diagnostics shows how to export evidence safely.
Tune and extend
Customization covers config, mpv, and Discord presence. Developers: Contribute.
Browse by section
- User guides - install, shell, recovery, offline, privacy
- Developer - contribute, debug, docs maintenance
- Supported and unsupported - product boundaries and scope
Last updated on