Linux Windows Marketplace

Usage

Type help in the SpoTUI command bar to see a list of available commands.

Command	Description
tui -l <on/off>	Toggle ASCII logo visibility
tui -l -a <on/off>	Toggle ASCII animation
tui -wp <url> [-o <opacity>]	Set wallpaper (opacity 0-1)
tui -t pull <theme_id> [-live]	Apply a theme by its ID from the stable feed, or the live feed with -live (you can find the id on our website)
tui bind "<Letter>" "<command>"	Binds Alt+<Letter> to run a TUI command
tui unbind "<Letter>"	Remove the Alt+ keybind
tui bind clear	Remove all keybinds
tui actions create <name>	Create a named action
tui actions "<name>" "<listener>" "<command>"	Bind an action to a listener
tui actions list	List saved actions
tui actions enable <name>	Enable an action
tui actions disable <name>	Disable an action
tui actions delete <name>	Delete an action
tui -wp off	Remove wallpaper
tui -ly -cp -active <#hex> -inactive <#hex> -near <#hex>	Set lyrics colors
tui -ly -cp off	Reset lyrics colors
tui -ly -animation <on/off>	Toggle lyrics loader animation
tui -ly -spacing <value>	Controls vertical spacing between lines in lyrics
tui -ly -spacing off	Resets line spacing in lyrics
tui -viz -color <#hex>	Set visualizer bar color
tui -viz -gap <px>	Set gap between visualizer bars (0 = touching)
tui -viz -gap off	Reset visualizer bar gap
tui -viz -bars <count>	Set how many visualizer bars to show
tui -viz -bars off	Reset visualizer bar count
tui -viz -smooth <1-100>	Set visualizer bar smoothing
tui -viz -smooth off	Reset visualizer bar smoothing
tui -viz -mode <adaptive/global>	Set visualizer reaction mode
tui -viz -mode off	Reset visualizer reaction mode
tui -viz off	Reset visualizer bar color
tui -bar -bg <#hex> -border <#hex> -text <#hex>	Set player bar colors
tui -bar -v <on/off>	Toggle native play bar visibility
tui -bar -c <on/off>	Toggle custom TUI play bar
tui -bar -c -progress <id>	Set custom play bar progress style
tui -bar off	Reset player bar colors
tui -progress -bg <#hex> -fg <#hex>	Set progress bar colors
tui -progress off	Reset progress bar colors
tui -inputs -bg <#hex> -bg-hover <#hex> -text <#hex> -border <#hex>	Set input colors
tui -inputs -buttons <on/off>	Toggle bottom right buttons visibility
tui -inputs off	Reset input colors
tui -panel -bg <#hex> -border <#hex> -text <#hex>	Set help/playlist/theme/about panel colors
tui -panel off	Reset panel colors
playlist / list <playlist-name>	Open playlist viewer or play a specific playlist
add2list	Add the current song to a playlist
queue	View and reorder the play queue
play / pause / p	Toggle playback
skip	Next track
back	Previous track
s / seek <mm:ss>	Jump to a specific time
v / volume <%>	Set volume (0-100)
shuffle	Toggle shuffle
loop / superloop	Toggle repeat mode
like	Like/unlike current song
lyrics	Toggle lyrics panel
visualizer	Toggle audio visualizer
dj	Play the DJ playlist
echo <text>	Display a message
search <query>	Search Spotify
about	Show about panel
theme	Browse and apply themes
discord	Show the Discord update banner and re-enable it on boot
standby	Enter standby mode (any key to exit)
jam create	Start a listening jam and get a PIN
jam join <pin>	Join a jam by PIN (volume/lyrics only)
jam leave	Leave the current jam
help	Show the help panel

Action Targets

Actions run a command when a listener fires. Create one, then bind it:

tui actions create autolyrics
tui actions "autolyrics" "actions:spotui@pane_close>!lyrics" "lyrics on"

Target	Description
actions:spotui@pane_close	Fires when any pane closes
actions:spotui@pane_close>help	Fires when the help pane closes
actions:spotui@pane_close>about	Fires when the about pane closes
actions:spotui@pane_close>playlist	Fires when the playlist pane closes
actions:spotui@pane_close>theme	Fires when the theme pane closes
actions:spotui@pane_close>lyrics	Fires when the lyrics pane closes
actions:spotui@pane_close>search	Fires when the search pane closes
actions:spotui@pane_close>!<pane>	Fires when any pane except <pane> closes
actions:spotui@pane_close><pane> | spotui@pane_close><pane>	Fires when any listed pane closes
actions:spotui@pane_close>!<pane> | spotui@pane_close>!<pane>	Fires when the closed pane is none of the listed panes

Custom Play Bar Progress Styles

When the native Spotify play bar is hidden (tui -bar -v off), you can enable a custom, text-based TUI play bar (tui -bar -c on). This bar has a progress indicator with 14 different style presets.

To set a progress style, use the command: tui -bar -c -progress <id>

Available Styles

ID	Preview Example	Description
classic-block	████████░░░░░░░░	Classic TUI block progress
dark-block	▓▓▓▓▓▓▓▓░░░░░░░░	Dark block progress
gradient	██████▓▓▒▒░░░░░░	Smooth block gradient
thin	━━━━━━━━░░░░░░░░	Bold thin line with empty blocks
line	━━━━━━━━────────	Smooth heavy and light line indicator
square	■■■■■■■■□□□□□□□□	Square bullet style
circle	●●●●●●●●○○○○○○○○	Circular bullet style
diamond	◆◆◆◆◆◆◆◆◇◇◇◇◇◇◇◇	Diamond bullet style
chevron	>>>>>>>>░░░░░░░░	Arrow / Chevron progress
triangle	▶▶▶▶▶▶▶▶▷▷▷▷▷▷▷▷	Solid and empty play-button triangles
braille	⣿⣿⣿⣿⣿⣿⣿⣿⣀⣀⣀⣀⣀⣀⣀⣀	Braille dot block progress
retro	▰▰▰▰▰▰▰▰▱▱▱▱▱▱▱▱	Retro segment blocks
pixel	█▀█▀█▀█▀░░░░░░░░	Checkerboard pixel progress
dashed	━━━━━━━╸────────	Dashed track with end handle

Bundling from Source

The theme's JavaScript lives as ES modules in src/ and must be bundled into a single theme.js before it can be loaded by Spicetify.

From the theme root, run:

npx rollup src/main.js --file theme.js --format iife

This bundles src/main.js and outputs theme.js in the theme root (next to manifest.json and user.css).

Contributing

You can add your own theme to the theme browser by visiting spotui.root.sx.

Note: To help prevent broken themes and spam, you must sign in with GitHub to submit a theme.

Note: Do not commit the bundled theme.js. All PRs with the bundled JS will be closed.

---

Stonks

---

---

Linux

Linux

1. Go in the SpoTUI Docs. 2. Select "Getting Started". 3. Follow the guide.

> Note: If you are using Spicetify v3, follow the guide in the "spotui@<version>" release.

Windows

Windows

1. Go in the SpoTUI Docs. 2. Select "Getting Started". 3. Follow the guide.

> Note: If you are using Spicetify v3, follow the guide in the "spotui@<version>" release.

Marketplace

Marketplace

1. In Spotify, go to the Spicetify Marketplace. 2. Select "Themes" and search for SpoTUI. 3. Install the theme.

> Note: If you are using Spicetify v3, follow the guide in the "spotui@<version>" release.

License

Copyright (C) 2026 SkenS (SkenSMasteR). SpoTUI is licensed under the GNU General Public License v2 (GPL-2.0). See the LICENSE file.