skip to content
MusesΜοῦσαιdocs

running / 15 of 15

Command line

phonto plays what you name until you stop it. Subcommands list displays, save a frame and, on macOS, install a lock screen video.

What to play

flag what it does
PATH A file, a stream URL or a YouTube link, on every display.
--rand A random video from the search paths, on every display.
--display <ID> <PATH> This video on this display. Repeats.
--display-rand <ID> A random video on this display. Repeats.

With none of these, phonto plays the [[display]] entries in config.toml, and stops with an error if there aren’t any. A path and --rand each work alone. The two --display flags combine with each other.

How it plays

flag what it does
--scale <MODE> fill, fit, stretch or center. See Fitting the screen.
--layer <LAYER> Linux only. background, bottom, top or overlay. See Layers.
--shader <PATH> Linux only. A GLSL fragment shader for every frame. See Shaders.
--pause-on-battery Pauses while on battery. See Battery.
--pause-below <PERCENT> Pauses while on battery with less charge than this.

YouTube

These apply to dump too.

flag what it does
--yt-dlp-format <FORMAT> The format for yt-dlp to pick, as its -f.
--cookies-from-browser <BROWSER> Signs yt-dlp in with this browser’s session.
--yt-dlp-args <ARGS> More flags for yt-dlp, split on spaces.

See YouTube.

Commands

command what it does
phonto displays Lists the displays phonto can see, with the ID to use for each.
phonto dump <PATH> -o <OUT> Saves one frame as an image. --at picks the second, and on Linux --shader applies a shader. See Still frames.
phonto install-live-lockscreen <PATH> macOS only. Adds the video to the system’s wallpapers, for the lock screen. --name names it and --remove takes it out. See Lock screens.

phonto --help lists every flag, and phonto --version prints the version.

Logs

phonto prints errors only. For more, set RUST_LOG:

shell
RUST_LOG=info phonto --rand

info shows what phonto is doing, such as displays attaching and detaching, and pausing for the battery. debug adds more.