LinuxCommandLibrary

spicetify

Customize and enhance the Spotify desktop client

TLDR

Generate a configuration file on very first run and display help

$ spicetify
copy

Backup and preprocess Spotify application files
$ spicetify backup
copy

Print all configuration fields and values
$ spicetify config
copy

Change the value of a configuration field
$ spicetify config [field] [value]
copy

Apply the customization changes to Spotify
$ spicetify apply
copy

Restore Spotify to its original state
$ spicetify restore
copy

SYNOPSIS

spicetify command [options]

PARAMETERS

apply
    Applies all configured themes, extensions, and apps to the Spotify client. This command is crucial after any configuration changes.

backup
    Creates a backup of the current Spotify client's original files and configurations before Spicetify modifications are made. Essential for safety.

restore
    Restores the Spotify client to its original state from a backup, effectively removing all Spicetify customizations.

config
    Manages Spicetify's core configuration settings. Used to enable/disable themes, extensions, and apps, or to set paths. It supports sub-commands like set, get, add, remove, inject, uninject, and reset.

update
    Updates Spicetify to its latest version. This command often re-applies customizations if Spotify's internal structure has changed.

enable-devtool
    Enables developer tools within the Spotify client, which are useful for debugging custom themes and extensions.

disable-devtool
    Disables developer tools within the Spotify client.

watch
    Monitors Spicetify's configuration files for changes and automatically applies them to the Spotify client in real-time.

path
    Displays the installation path of Spicetify and its configuration directory.

version
    Shows the current version of the Spicetify tool.

help
    Displays help information for the Spicetify command or specific sub-commands.

DESCRIPTION

Spicetify is a powerful command-line tool designed to extensively customize the official Spotify desktop client. It functions by injecting custom CSS, JavaScript, and other resources into the Spotify application's files, allowing for a broad range of modifications. Users leverage Spicetify to apply custom themes that drastically change the visual appearance, install extensions to introduce new functionalities (such as lyrics, ad-blocking, or enhanced playback controls), and integrate custom applications directly into Spotify. This utility is particularly favored by Linux users who seek greater control and personalization over their desktop applications, pushing Spotify's customization capabilities far beyond its default settings. Spicetify also offers essential commands for backing up and restoring original configurations, updating the tool, and managing various customization components, ensuring a flexible and recoverable customization experience.

CAVEATS

Spicetify directly modifies Spotify's application files, which can sometimes lead to instability or require re-application of customizations after Spotify client updates. Users might need to re-run spicetify apply or spicetify update after a Spotify client update to fix issues. While widely used, such modifications might technically fall outside Spotify's terms of service. For Spotify installed via sandboxed methods like Snap or Flatpak, additional permissions or setup steps are often necessary to allow Spicetify to access and modify the application's files.

INSTALLATION METHODS

Spicetify can be installed using a convenient one-liner script provided for most Linux distributions, or through manual installation for users desiring more control. For Arch Linux users, it's typically available via the Arch User Repository (AUR).

Important Note: If Spotify is installed using Snap or Flatpak, extra steps are often required. This usually involves granting Spicetify explicit permissions to interact with the sandboxed Spotify application, often via commands like sudo snap connect spotify:hostfs for Snap installations, or similar Flatpak commands.

COMMUNITY AND RESOURCES

The Spicetify project boasts an active community primarily found on GitHub and Reddit. The official GitHub repository serves as the central hub for documentation, issue tracking, and contributions. This community is a rich source for a vast array of user-created themes, extensions, and apps, significantly enhancing the Spotify customization ecosystem. Many popular customizations are directly maintained and distributed through community repositories linked from the main project.

HISTORY

Spicetify originated as an open-source initiative, driven by the community's desire for deeper customization of the Spotify desktop client beyond the limited official options. It rapidly gained popularity, especially within the Linux desktop community, due to its powerful capabilities and flexibility. Its development is entirely community-driven, with continuous contributions of themes, extensions, and bug fixes, ensuring its evolution alongside changes in the Spotify client itself.

SEE ALSO

spotify (application), snap(1), flatpak(1), git(1)

Copied to clipboard