spicetify/cli
Cli
This project is a command-line utility and development framework designed to modify, extend, and customize the Spotify desktop client. It functions as a binary patching engine that injects custom scripts, stylesheets, and interface components directly into the host application, enabling users to alter visual themes and add new functionality.
The tool distinguishes itself by providing a comprehensive development environment for building modular extensions and custom applications. It includes a hot-reloading pipeline for rapid iteration, a declarative library for constructing interactive UI panels, and deep integration with the player's internal state. Developers can manipulate playback controls, register global keyboard shortcuts, and create context-aware menus or tooltips that integrate seamlessly with the native interface.
Beyond customization, the project offers robust administrative control over the client environment. It manages the full lifecycle of extensions and themes, provides automated backup and restoration of the original application state, and includes diagnostic tools like remote debugging and component inspection to facilitate troubleshooting.
The project is distributed as a command-line interface, allowing users to manage configurations, apply modifications, and maintain compatibility with client updates through structured terminal commands.
Features
- Desktop Customization Frameworks - Acts as a command-line tool for injecting themes, extensions, and custom functionality into the desktop application.
- Extensible Media Players - Provides a development environment for building and managing modular plugins that extend the features and UI of the media player.
- Desktop Clients - Modifies the desktop client to enable custom visual themes, interface extensions, and advanced playback controls.
- Binary Patching Utilities - Modifies the host application executable at runtime to inject custom hooks and enable external script execution.
- Desktop Environment Customizers - Modifies the appearance and functionality of desktop applications by injecting custom themes and extensions.
- Playback Controllers - Interacts with the internal media player to programmatically manage playback states and audio settings.
- Media Player Controls - Provides programmatic control over media playback, queue management, and track metadata within the desktop client.
- Visual Theme Engines - Overrides native application styles by injecting custom stylesheets to redefine the visual appearance of interface components.
- Injection Frameworks - Loads and executes user-defined scripts within the host application process to manipulate internal state.
- Playback Behavior Enhancements - Modifies audio playback behavior by enabling features like true random shuffling and segment looping.
- Client Configuration - Manages application configuration, backups, and state restoration through command-line instructions.
- Extensible Application Frameworks - Provides a framework for building modular extensions and custom applications that integrate directly into the desktop client.
- Extensibility - Provides a framework for injecting custom extensions to add features and manipulate interface elements.
- Event-Driven Plugin Registries - Registers custom logic to respond to internal application events like playback changes and user interactions.
- Playback Monitoring - Registers listeners to trigger custom logic upon playback state changes.
- Playback Control Injections - Injects interactive buttons into the playback interface to trigger custom actions or toggle player states.
- Custom Theme Injectors - Defines visual styles by injecting custom stylesheets and assets to alter the interface appearance.
- Declarative Component Libraries - Provides a declarative library for constructing interactive application components and managing state.
- Declarative UI Libraries - Provides a declarative library of modular building blocks for constructing custom interface panels.
- Interface Style Sheet Customizers - Provides a mechanism to inject custom CSS stylesheets into the desktop client for visual personalization.
- Application Customization Frameworks - Injects themes, extensions, and custom applications to modify client appearance and functionality.
- Hot Reloading - Monitors source files for changes and automatically refreshes injected assets to enable rapid iterative development.
- Workflow Optimization Tools - Streamlines development with hot-reloading, remote debugging, and automated build tools for rapid iteration.
- Extension Managers - Provides a centralized dashboard to discover, install, update, and remove themes and extensions.
- Backup Utilities - Creates copies of original client files to ensure a clean state can be restored after modifications.
- Custom Component Extensions - Extends the user interface with custom visual components, pop-ups, and navigation tools.
- Custom UI Components - Facilitates the creation of modular, interactive UI panels that integrate with the host application.
- Track Interaction Widgets - Places custom widgets next to track information to perform stateful actions on the currently playing media.
- Theme Management - Manages the installation and removal of visual themes through local configuration directories.
- Visual Themes - Applies custom color schemes and style rules to override default interface elements.
- Custom Page Frameworks - Integrates standalone custom pages into the application sidebar to extend native functionality.
- Internal Application Interfaces - Enables deep integration with the player's internal state for building custom extensions.
- Desktop Client Management - Removes all patches and customizations to restore the application to its original state.
- Extension Compilers - Transforms source code into functional extensions for the desktop client using high-performance build tools.
- Firefox Add-on Management - Provides a centralized dashboard to toggle, update, or remove installed extensions and themes.
- Audio Playback - Enables appending audio tracks to the active playback queue using unique identifiers.
- API Request Authentication - Automatically attaches session headers and cookies to outgoing network calls for authenticated communication.
- Client - Creates snapshots of application files to enable restoration after modifications.
- Header Button Injections - Injects interactive buttons into the application header area to provide quick access to global features.
- Color Scheme Managers - Enables switching between predefined color variations within a theme to adjust the visual palette.
- Component Registration Systems - Provides a registration system to dynamically add and manage custom UI components within the application.
- Context Menu Customizations - Adds custom interactive options to the right-click menus of tracks, albums, and artists to trigger user-defined actions.
- Page Management Systems - Manages internal routing between custom views and native pages for multi-page workflows.
- Sidebar Layouts - Assembles structured side panels using specialized layout components for custom content.
- User Confirmation Dialogs - Renders confirmation dialogs with custom titles and action handlers for user interactions.
- Client-Side Data Persistence - Stores key-value pairs in the local environment to maintain user settings or application state across sessions.
- Operation Execution - Sends queries and mutations to remote services to retrieve or modify data structures.
- Local Data Persistence - Stores and retrieves key-value pairs in local storage, namespaced by user account to maintain isolated settings.
- Server State Managers - Synchronizes, caches, and updates data fetched from remote sources to ensure interface consistency with backend information.
- Client Update Utilities - Ensures custom extensions remain functional and compatible after the host application receives updates.
- Component Inspection Tools - Provides tools to examine the internal state and visual structure of interface components.
- Debugging Tools - Unlocks built-in debugging interfaces to facilitate inspection of themes and extensions.
- Global Keyboard Shortcuts - Binds custom actions to specific key combinations so that extensions respond to user input within the desktop client.
- Media Metadata Retrievers - Fetches detailed media information like artist and album names for context-aware interface modifications.
- Panel Visibility Controllers - Manages the visibility and lifecycle of interface panels through unique identifiers.
- Application Settings Management - Updates and manages application settings, including lists of active extensions and custom apps.
- Local Configuration Files - Manages user preferences and assets through a structured directory of local configuration files.
- Functional Extensions - Executes custom code alongside the desktop client to integrate external services and add features.
- Client Navigation Controllers - Spicetify controls the internal router to switch between views, push new pages onto the history stack, and manage the current location state.
- Custom Header Components - Enables the construction of interactive panel headers with custom navigation and action controls.
- Declarative UI Components - Provides a declarative library for constructing interactive UI panels and sidebar components.
- Interactive UI Elements - Renders standard interactive controls like toggles and menus to maintain consistent user interaction patterns.
- Modals - Renders interactive popup windows to present information or collect user input.
- Notification Customization - Triggers toast notifications with custom styling and configurable display duration.
- Class Merging - Manages and merges CSS class names dynamically to update interface appearance.
