tvctl
A Rust CLI that lets agents (or people) play videos and music in windows on this computer and control them from the command line, like a TV remote for your screen. (It does not control physical TVs.) Every command prints JSON to stdout; errors go to stderr with exit code 1.
Services are plugins (tvctl plugins lists them). Currently: YouTube,
Spotify (web player), Netflix, Amazon Prime Video (amazon.com and amazon.co.jp)
and Crunchyroll.
macOS only for now.
Install
ChatGPT / Codex plugin and agent skill
skills/tvctl/SKILL.md teaches an agent to install or update tvctl
(cargo install tvctl at the start of every session) and to use it.
scripts/package-skill.sh builds:
dist/tvctl-plugin.zip: an Agent Plugins 1.0 package (plugin.jsonat the root,skills/tvctl/SKILL.md) for ChatGPT and Codex. To install it, give the zip to ChatGPT and ask it to install the plugin. To publish it, upload it on the Plugins page of the OpenAI Platform dashboard.dist/tvctl-skill.zip: the bare skill, for "Upload a skill" in ChatGPT or Claude, or copyskills/tvctlinto any agent's skills directory.
tvctl opens windows on your Mac, so the agent must be able to run commands on that Mac (for example the ChatGPT desktop app, Codex CLI, Claude Code, pi); cloud sandboxes cannot show anything on your screen.
Usage
# => {"id": "1", "service": "youtube", "backend": "webview", "player": {...}, "window": {...}}
| |
|
The background server starts on demand (open, auth) and stops a few seconds
after the last player closes (TVCTL_IDLE_SECS, default 5), quitting
tvctl's Chrome too. tvctl server up keeps it running without players
(avoids restarting Chrome between uses); tvctl server down stops it and
closes all players; tvctl server status shows its state.
--size is the video area; layouts without --size fill their screen region.
tvctl --help describes the workflow, the JSON output and error format, and
examples; tvctl <command> --help describes each argument.
Ducking
tvctl duck on lowers every player while other audio plays (for example a
voice assistant speaking) and restores it when that audio has been silent for
a moment. "Other audio" is every app except tvctl's own players, or only the
apps given with --apps (app names such as ChatGPT, process names, or bundle
ids; tvctl duck apps lists what is playing now). --level is the volume
while lowered, in percent of each player's own volume (default 10). The
setting is saved (duck.json in the data directory) and applies whenever
players are open; tvctl duck off turns it off.
- Nothing is rerouted: tvctl measures the other apps' audio with a Core Audio process tap (macOS 14.2+), which only copies it. The first time, macOS asks for permission to record system audio, on behalf of the app that started tvctl (e.g. the terminal); allow it under System Settings > Privacy & Security > Screen & System Audio Recording.
- The volume is lowered inside the player pages, so it works for every
service, and
volume/statuskeep showing the player's own volume. (Sound a page plays through Web Audio instead of media elements is not lowered.) tvctl duck statusshowsducking(lowered now),peak_db(level of the monitored audio),sources(monitored apps playing now) anderror.
Casting from the YouTube app
tvctl cast on makes this Mac a YouTube cast target: phones and computers on
the same network list it (as tvctl (<computer name>), or --name) in the YouTube app's Cast
menu. A cast video opens in a tvctl player (Chrome when you are logged in, so
Premium plays without ads); play, pause, seek, volume and the queue
(next/previous, the next video when one ends) are controlled from the app, and
the app shows the player's state. A new video replaces the cast window at the
same place and size; tapping Disconnect in the app closes it.
- The receiver runs in the tvctl server, which does not stop when idle while
casting is on. After a reboot or
tvctl server downit runs again as soon as the server starts (tvctl cast on,tvctl server up,open, ...). - Discovery uses DIAL (SSDP on UDP port 1900 and an HTTP port); macOS may ask
to allow incoming connections, and iOS asks the YouTube app for local network
access. If the Mac does not appear, use
tvctl cast codein the app under Settings > Watch on TV > Link with TV code. - YouTube only (YouTube Music casting is refused). Autoplay of recommended videos after the queue ends is not supported.
- It uses YouTube's unpublished TV (Lounge) API, as YouTube TV apps do, so YouTube changes can break it. The protocol follows yt-cast-receiver (MIT).
- Settings are in
cast.jsonand the receiver's ids incast-state.jsonin the data directory.
Blackout
A player that has been paused or has ended for 60 seconds turns black (the
whole window content). Moving the mouse over the window, clicking, scrolling or
typing in it brings the picture back without passing that input to the player,
as do playback resuming and any tvctl player command except status; if it stays paused, it
turns black again after another 60 seconds. window.blackout in the output
shows whether it is black now (a screenshot is black then too).
TVCTL_BLACKOUT_SECS sets the wait when the server starts (0 turns it off).
Backends
- webview: a native window with a WebView (tao + wry). No dependencies. Used for services with public embed APIs (YouTube logged out).
- chrome: an app window of Google Chrome, driven through the Chrome DevTools
Protocol, using a dedicated profile at
~/Library/Application Support/tvctl/chrome-profile. Used where a login or DRM is needed. Chrome refuses DevTools control of your everyday profile, so tvctl has its own; sign in to each service once withtvctl auth login. Always-on-top is not available in this backend.
A plugin lists its backends in order of preference. If a plugin declares
prefer_backend_when_logged_in and you are logged in, that backend is used
(YouTube: Chrome, so Premium accounts get no ads). open --backend overrides.
Run tvctl from a terminal on the Mac's own screen. A server started from an
SSH session cannot use the macOS keychain, where Chrome keeps the key for its
saved cookies, so logins would not be saved or loaded: such a server refuses
auth login and adds a warning to auth status, server status and Chrome
players (server status also shows ssh_session). Stop it with
tvctl server down and start tvctl again from the Mac's screen.
auth login opens the login page in a plain Chrome (not controlled, because
Google refuses sign-in in automated browsers) on tvctl's profile. Sign in, then
quit that Chrome with Cmd+Q; tvctl then checks the login cookies.
Services
| Plugin | Backends | Login | Supported actions |
|---|---|---|---|
youtube |
webview (logged out), chrome (logged in) | optional (Premium: no ads) | all; audio only in chrome |
spotify |
chrome | required | play, pause, toggle, next, previous, seek, volume, mute |
netflix |
chrome | required | all except previous, quality |
primevideo |
chrome | required (amazon.com and/or amazon.co.jp account with Prime Video) | all except previous |
crunchyroll |
chrome | required (most titles need Premium) | all except previous |
Spotify links: tracks, albums, playlists, artists and episodes on
open.spotify.com. A track link plays that track; other pages start from the top.
Spotify opens in its large cover-art view (shown inside the window, so window
layouts keep working). The plugin drives the web player's UI (no public API), so Spotify UI
changes can break it; the E2E tests detect that.
Netflix links: netflix.com/watch/<id> (and ?t=<seconds>) and
netflix.com/title/<id> (plays like the page's Play button: a show resumes its
current episode). Status includes episode {title, number, season} and
next_episode; next switches to it in place. Subtitles prefer full subtitles
over closed captions (type: PRIMARY / ASSISTIVE), audio prefers regular
tracks over audio description; exact track ids from list also work. Speeds are
Netflix's menu rates (0.5 to 1.5). Netflix has no quality setting on the web.
Ads (plans with ads) are not skipped and are handled like Prime Video's
(ad_showing, refused actions, deferred --start/--subtitles). The plugin
uses Netflix's internal player API (seeking through it; setting the video
element's time directly breaks playback with error M7375).
Prime Video links: amazon.com/gp/video/detail/<id> and amazon.com/dp/<ASIN>
(US), amazon.co.jp/gp/video/detail/<id> (Japan, also with a language prefix
such as /-/en/), and primevideo.com/detail/<id> (opened on amazon.com).
The US and Japanese stores are separate accounts; sign in to each you use
(auth login primevideo and auth login primevideo --site jp); auth status
shows both under sites. A series page plays the episode its Play button would (usually the
next one to watch); a title resumes where it was left unless --start is given.
next starts the next episode (next_episode in status). Speeds are the
player's fixed rates (0.75 to 2); qualities are its data-usage settings good,
better, best. Ads are not skipped: while one plays, ad_showing is true,
ad_remaining gives the seconds left, seeking/subtitles/audio/speed are
refused, and --start/--subtitles of open are applied when it ends
(pending). Amazon limits simultaneous streams per account; a window that
cannot play reports the player's message (e.g. "Maximum Streams Playing") as an
error. The plugin uses the web player's internal stores (no public API), so
Prime Video changes can break it; the E2E tests detect that.
Crunchyroll links: crunchyroll.com/watch/<id>/<slug> (an episode or movie)
and crunchyroll.com/series/<id>/<slug> (plays like the series page's
Start/Continue button). An episode resumes where it was left unless --start
is given. The player fills the window; the rest of the watch page is hidden.
Status includes episode {id, title, number} and next_episode; next
switches to it in place. Subtitles are burned into the video (switching reloads
the stream for a moment), and each dub is its own episode id, so audio <lang>
changes video_id and the URL. Subtitle and audio choices become the profile's
preferences, as in the site's menus. Speeds are the menu's 0.5, 0.75 and 1;
qualities are highest, moderate (720p) and data_saver (480p). Tested with
Premium; on ad-supported plans ad_showing reports ads (untested). Crunchyroll's
Cloudflare bot check ("Verify you are human") can block tvctl's Chrome, mostly
after many page loads in a short time; open then says so. Pass the check in
the plain Chrome of tvctl auth login crunchyroll (open any episode there),
quit it, and retry. The plugin drives the web player's internal player object
(reached through its React controls), so site changes can break it; the E2E
tests detect that.
Plugins
Each service is a directory plugins/<name>/:
plugin.toml:name,description,domains(subdomains match too),backendsexamples: example URLs (each must be on one of thedomains) andnotes: what agents and users need to know (how to find URLs, limits, accepted values, ads, login hints).tvctl --helplists every installed service with its first example, andtvctl plugins <name>shows the rest, so agent instructions (skills/tvctl/SKILL.md) need no per-service text.actions: supported player actions; optional[unsupported_actions]lists actions a backend lacks (e.g.webview = ["audio"]). The server refuses other actions with an error listing the supported ones, andtvctl pluginsshows both, so agents can check before calling.- optional
[auth]:required(playback needs a login),login_url,cookie_url,logged_in_cookies,prefer_backend_when_logged_in,login_mode(plainby default, orcontrolled). Services with several separately signed-in sites (e.g. regional stores) name the main site withsiteand add others as[auth.sites.<name>]with their ownlogin_url,cookie_urlandlogged_in_cookies;auth login <service> --site <name>signs in to one, and the service counts as logged in when any site is.
webview.html: the page for the WebView backend.frame.js(optional): injected into that WebView's subframes.chrome.js: the adapter for the Chrome backend. It is loaded into every document of the player window, so it can restore its page state after reloads.
Adapters define window.__tvctl.run(action), which returns a status object.
Actions: open {url, start, paused, subtitles}, status, play, pause,
toggle, next, previous, seek {seconds, relative}, subtitles {lang}, audio {lang},
volume {level, muted}, speed {rate}, quality {level}. Unsupported actions
throw. In the Chrome backend, open may return {"navigate": url} to be loaded
at another URL first.
Built-in plugins are compiled into the binary. Plugins in $TVCTL_PLUGIN_DIR
or ~/.config/tvctl/plugins/<name>/ are loaded when the server starts and
override built-ins with the same name.
Environment
TVCTL_SOCKET: server socket (default$TMPDIR/tvctl.sock; the log is next to it astvctl.log)TVCTL_DATA_DIR: data directory (Chrome profile, login state)TVCTL_PLUGIN_DIR: external plugin directoryTVCTL_CHROME: Chrome executableTVCTL_IDLE_SECS: idle time before an on-demand server stops (default 5)TVCTL_BLACKOUT_SECS: how long a player stays paused or ended before it turns black (default 60; 0 turns blackout off)
For plugin development, the hidden command tvctl __eval <ID> <JS> evaluates
JavaScript in a Chrome-backend player page and prints the (awaited) result.
Tests
TVCTL_E2E_PROFILE="/Library/Application Support/tvctl" \
TVCTL_E2E_PROFILE="/Library/Application Support/tvctl" \
TVCTL_E2E_PROFILE="/Library/Application Support/tvctl" \
TVCTL_E2E_PROFILE="/Library/Application Support/tvctl" \
The end-to-end tests open windows. e2e_fake uses a fake plugin and a local site.
Releasing
Bump version in Cargo.toml and plugin/plugin.json (they must match) and
push to main. .github/workflows/release.yml then publishes the crate to
crates.io, tags v<version> and creates a GitHub release with
dist/tvctl-plugin.zip and dist/tvctl-skill.zip. Versions that already have
a tag are skipped; the workflow can also be started by hand (workflow_dispatch).
It needs the CARGO_REGISTRY_TOKEN repository secret.
e2e_youtube uses a fresh logged-out profile, so ads may play and the tests
wait for them. To use your logged-in profile instead, set
TVCTL_E2E_PROFILE="$HOME/Library/Application Support/tvctl".