Feature Tour
Every Kunai capability in one place: what is shipped, what is experimental, and what is explicitly out of scope, with the shell commands that reach each one.
Kunai is a terminal-first media shell. It resolves media streams from third-party
providers, hands playback to mpv, and keeps recovery, offline, and diagnostics
in the same session.
Who this is for: users who want a capability map with live command and provider tables.
You will learn: launch entry points, shell commands, registered providers, and what is stable vs experimental in the current beta.
Launch entry points
Common launch patterns. For the full flag list synced from kunai --help, see
CLI Reference.
| Invocation | What it does |
|---|---|
kunai | Open the shell; search, browse, or pick from history |
kunai -S "Title" | Search and show results |
kunai -S "Title" --jump 1 | Search, auto-select first result |
kunai -S "Title" -q | Quick mode; same as --jump 1 with search |
kunai -a -S "Anime" | Anime mode (anime providers) |
kunai -i 438631 -t movie | Open a specific TMDB ID directly |
kunai --continue | Jump to the newest unfinished history entry |
kunai --history | Open watch history first |
kunai --offline | Open completed offline library first |
kunai --discover | Open recommendations first |
kunai --calendar | Open release calendar first |
kunai --random | Open random picks tray first |
kunai --open <url> | Play a shared kunai:// link (trusted launch) |
kunai --setup | Run setup wizard |
kunai --download -S "Title" | Download-only flow for a title (no shell queue UI) |
kunai --zen | Minimal chrome mode |
kunai --debug | Verbose logging to ./logs.txt |
Download vs queue
kunai --download(with-Sor-i): bootstrap a title, run downloads, exit./downloadsin the shell: manage the download queue while the shell is open./downloadduring playback: queue the current item for offline.
Shell commands
Press / to open the context-aware command palette. The complete, searchable
table of every registered shell command lives on
Commands and shortcuts.
Active providers
Live registry; same table as Providers. Provider names link to per-provider notes.
| Provider | Domain | Media | Status | Description |
|---|---|---|---|---|
| Videasy videasy | videasy.to | movie, series | Active | Registered movies/series adapter; source and subtitle inventory vary by title |
| VidLink vidlink | vidlink.pro | movie, series | Active | Movies and series with multi-language subtitles |
| VidRock vidrock | vidrock.net | movie, series | Active | Backup source for movies and series with direct video files |
| Rivestream rivestream | rivestream.app | movie, series | Candidate | Candidate movies/series adapter; quality varies by title |
| Movy movy | movy.sx | movie, series | Candidate | Movies and series via a multi-lane source aggregator |
| AniDB anidb | anidb.app | anime | Active | anidb.app catalog and streams — ani-cli v5's source; second in the default anime order |
| AllManga allanime | mkissa.to | anime | Active | Anime episodes in sub and dub — the ani-cli parity source, third in the default order |
| HiAnime hianime | hianime.at | anime | Production | Anime episodes in sub and dub via HiAnime (ani-cli parity lane) |
| Miruro miruro | www.miruro.bz | anime | Active | Primary anime source — sub and dub from many backends behind one AniList-keyed pipe |
| AnimeGG animegg | www.animegg.org | anime | Active | Independent anime source — direct MP4s, sub and dub, no AniList dependency |
| KickAssAnime kickassanime | kaa.lt | anime | Active | Independent anime source — HLS with separate subtitle tracks, sub and dub |
| YouTube youtube | youtube.com | video | Production | YouTube via Invidious search and yt-dlp playback |
Providers not in the production engine
- Cineby: Videasy flavor research module; not registered in the CLI container.
- VidKing: legacy config/cache alias for Videasy. Do not use in new code.
What works well
- Search by title with TMDB-backed metadata
- Movie and series resolve can use the registered Videasy, VidLink, and Rivestream adapters
- Anime resolve starts with Miruro, then KickAssAnime, then AnimeGG, then AniDB, then AllManga (
allanime); every registered anime provider is tried automatically - YouTube mode via Invidious search and yt-dlp playback
- Watch history with resume support
- Continue Watching with unfinished/new episode detection
- Release calendar with cached schedule data
- Recommendations and discovery surfaces
- Share links (
/share,/watch,kunai --open) - Offline downloads via yt-dlp with artifact validation
- Library browsing from local SQLite
- Diagnostics panel and redacted support bundle export
- Discord Rich Presence
- AniList and TMDB sync for watch progress (experimental; fail-closed until the promotion gate passes)
- Optional user-owned provider geo relay for metadata APIs
What is experimental / candidate
- Rivestream and Miruro: candidate status in manifests; quality varies by title
- Zen mode (
--zen): minimal chrome, still settling - Notifications inbox: active, alert delivery maturing
- Playlist queue: durable service active, multi-session recovery being validated
What is not supported
- Browser-based scraping (Playwright): archive-only reference
- Kunai-hosted cloud proxy infrastructure for video streams
- First-party streaming service authentication
- Content hosting or redistribution
- Native GUI outside the terminal
- Native app store packages (use
install.sh/install.ps1or package managers instead) - Silent mode-switching between online and offline
- Stream URLs in unredacted support bundles
Hotkeys
| Context | Keys | Action |
|---|---|---|
| Anywhere | / | Open command palette |
| Browse results | Tab | Cycle catalog mode (series / anime / YouTube) |
| Browse results | Ctrl+F | Narrow loaded results |
| Browse results | Enter | Open or play selected result |
| Browse results | Shift+Enter / i | Open title details |
| Browse results | /filters | Open the filter surface |
| Browse results | Ctrl+D | Queue for download |
| Browse / pickers | Esc | Clear, close, or go back |
| Playback | r | Recover current stream |
| Playback | ⇧F | Try next compatible provider |
| Playback | d | Open diagnostics |
| Playback | o | Choose source |
| Playback | k | Choose quality |
| Playback | n / p | Next / previous episode |
| Playback | a / u | Toggle autoplay / autoskip |
Diagnostics flow
/diagnostics → runtime panel with provider timeline
/export-diagnostics → redacted JSON bundle (no URLs, no tokens)
/report-issue → GitHub issue page with bundle guidance
--debug → verbose startup and runtime logging
--debug-json → structured JSONL event stream
--debug-session → full session traceSee Diagnostics and reporting for the user-facing guide.
Platform support
Release binaries via install.sh (Linux/macOS) and install.ps1 (Windows) embed the Bun runtime, so you do not need Bun installed to run them. Linux is supported; macOS and Windows x64 are beta; Windows ARM64 is experimental. Unsigned binaries may trigger SmartScreen or Gatekeeper on first run; see Install and update. Keep installs current with kunai upgrade.
| Platform | Install | Playback | Downloads | Poster previews |
|---|---|---|---|---|
| Linux (supported) | install.sh or bun/npm global | mpv | yt-dlp + ffprobe | Kitty / iTerm2 / Sixel / half-block (no install) |
| macOS (beta) | install.sh or bun/npm global | mpv | yt-dlp + ffprobe | iTerm2 / Sixel / half-block (no install) |
| Windows x64 (beta) | install.ps1 or bun/npm global | mpv | yt-dlp | iTerm2 / Sixel / half-block (no install) |
| Windows ARM64 (experimental) | install.ps1 | mpv | yt-dlp | iTerm2 / Sixel / half-block (no install) |
Storage architecture
| Store | Type | Contents |
|---|---|---|
| Config | JSON | ~/.config/kunai/config.json, provider overrides |
| Data DB | SQLite | History, lists, playlists, notifications, downloads |
| Cache DB | SQLite | Stream URLs, provider health, schedules |
| Logs | File | ./logs.txt when --debug is enabled |
Command and provider tables on this page are generated from the Kunai CLI (v0.3.0) at Oct 2, 2026, 9:34 AM UTC · source 9ce38f1ee10c. Run bun run --cwd apps/docs generate after registry changes. Docs maintenance
Last updated on
What You Can Do
A capability map of Kunai: search, play, recover, continue watching, discover, download for offline, share links, and diagnose, with the command for each.
Commands and Shortcuts
Every Kunai shell command, playback shortcut, overlay, and safe action, plus the full searchable command registry generated straight from the CLI itself.