Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sptui
command
Command sptui is a Spotify client for the terminal.
|
Command sptui is a Spotify client for the terminal. |
|
sptui-intros
command
Command sptui-intros is a workbench for sptui's startup animations: it plays them on a loop and lets you pause, step through frames, scrub, slow down and flip the theme, to inspect them closely.
|
Command sptui-intros is a workbench for sptui's startup animations: it plays them on a loop and lets you pause, step through frames, scrub, slow down and flip the theme, to inspect them closely. |
|
web
command
Command web serves sptui's website.
|
Command web serves sptui's website. |
|
internal
|
|
|
art
Package art draws cover images in the terminal: as real images with the kitty graphics protocol where the terminal supports it, otherwise as colored half-block "pixels" that work in any true-color terminal.
|
Package art draws cover images in the terminal: as real images with the kitty graphics protocol where the terminal supports it, otherwise as colored half-block "pixels" that work in any true-color terminal. |
|
atomicfile
Package atomicfile writes files so that a crash never leaves one half-written: the data goes to a temporary file that then replaces the real one.
|
Package atomicfile writes files so that a crash never leaves one half-written: the data goes to a temporary file that then replaces the real one. |
|
auth
Package auth logs in to Spotify (OAuth authorization code flow with PKCE) and keeps tokens on disk so users only log in once.
|
Package auth logs in to Spotify (OAuth authorization code flow with PKCE) and keeps tokens on disk so users only log in once. |
|
awake
Package awake stops the computer from going to sleep, and the screen from dimming or turning off, while sptui asks it to — the way music and video players do.
|
Package awake stops the computer from going to sleep, and the screen from dimming or turning off, while sptui asks it to — the way music and video players do. |
|
banner
Package banner is a tiny pixel font, 4 pixels tall, drawn two pixels per cell with half blocks, so each letter is 2 lines.
|
Package banner is a tiny pixel font, 4 pixels tall, drawn two pixels per cell with half blocks, so each letter is 2 lines. |
|
cache
Package cache keeps Spotify library responses on disk, in front of the Web API.
|
Package cache keeps Spotify library responses on disk, in front of the Web API. |
|
config
Package config loads sptui's settings from a TOML file.
|
Package config loads sptui's settings from a TOML file. |
|
demo
Package demo is an in-memory stand-in for Spotify.
|
Package demo is an in-memory stand-in for Spotify. |
|
intro
Package intro is sptui's startup animations.
|
Package intro is sptui's startup animations. |
|
logging
Package logging sets up slog.
|
Package logging sets up slog. |
|
lyrics
Package lyrics finds song lyrics on LRCLIB (https://lrclib.net), a free, open lyrics database.
|
Package lyrics finds song lyrics on LRCLIB (https://lrclib.net), a free, open lyrics database. |
|
speaker
Package speaker runs a Spotify Connect device inside sptui, so music plays right here on this computer.
|
Package speaker runs a Spotify Connect device inside sptui, so music plays right here on this computer. |
|
spotify
Package spotify is a small client for the parts of the Spotify Web API that sptui uses.
|
Package spotify is a small client for the parts of the Spotify Web API that sptui uses. |
|
tui
Package tui is sptui's terminal interface, built with Bubble Tea.
|
Package tui is sptui's terminal interface, built with Bubble Tea. |
|
update
Package update finds out whether a newer sptui has been released on GitHub, and installs it over the running binary, the way install.sh does.
|
Package update finds out whether a newer sptui has been released on GitHub, and installs it over the running binary, the way install.sh does. |
|
web
Package web serves sptui's website: the HTML pages and stylesheet in site/, embedded into the binary.
|
Package web serves sptui's website: the HTML pages and stylesheet in site/, embedded into the binary. |
Click to show internal directories.
Click to hide internal directories.