Skip to content

Command-line tool to customize Spotify client. Supports Windows, MacOS, and Linux.

License

Notifications You must be signed in to change notification settings

ChewOnThis/cablespicetifycli

 
 

Repository files navigation

CablespicetifyCLI Installation and Usage Guide

Welcome to CablespicetifyCLI! This tool allows you to customize your Spotify experience using Spicetify, along with a set of custom extensions and applications that enhance the functionality of your Spotify desktop client.

Features

  • Spotify Customizations: Modify the look and feel of Spotify with themes, extensions, and custom applications.
  • Node.js Server Integration: Manage Spotify token authorization and custom actions using a local server.
  • Easy Keyboard Shortcuts: Control and interact with Spotify effortlessly.
  • Spicetify Marketplace: Access themes, extensions, and more from Spicetify's Marketplace.

Installation Instructions

Requirements

  • Node.js: Please make sure you have Node.js installed on your system. If not, download it from Node.js official website.
  • Spotify Desktop Client: CablespicetifyCLI works with the Spotify desktop application, so make sure it is installed.
  • Spicetify: Install Spicetify by running the following command in PowerShell:
    iwr -useb https://raw.githubusercontent.com/spicetify/marketplace/main/resources/install.ps1 | iex

One-Line Installation Command

To install CablespicetifyCLI, run the following command in PowerShell (make sure PowerShell is not run as Administrator):

Set-ExecutionPolicy Bypass -Scope Process -Force; iwr -useb https://raw.githubusercontent.com/ChewOnThis/cablespicetifycli/main/installcablespicetifycli.ps1 | iex

This command will:

  1. Download and execute the installation script.
  2. Install Spicetify and set up extensions and custom applications.
  3. Start the local Node.js server to manage additional Spotify features.
  4. Restart Spotify to apply all modifications.

What the Installation Does

  • Downloads the CablespicetifyCLI repository from GitHub.
  • Extracts the contents into your local user directory (C:\Users\<Your Username>\AppData\Local\cablespicetifycli).
  • Installs Spicetify and copies custom extensions and applications.
  • Starts a local server at http://localhost:3000 for managing advanced Spotify interactions.

Getting Your Spotify Developer Details

To use CablespicetifyCLI, you need to set up a Spotify Developer application to obtain your Client ID and Client Secret. Follow these steps:

  1. Go to the Spotify Developer Dashboard.
  2. Log in with your Spotify account.
  3. Click Create an App.
  4. Fill in the details for your app (e.g., name, description) and click Create.
  5. Once the app is created, you will see the Client ID and Client Secret. Note these down as they will be needed during the installation.

Post-Installation

After installation, Spotify will restart, and all customizations will be applied. You will also be prompted to install Spicetify Marketplace, which gives you access to themes, extensions, and other community-created customizations.

Usage

Restart Spotify

  • Whenever changes are applied using Spicetify, Spotify must be restarted. This is automatically handled during installation.

Start the Local Server

  • If the local server is not running, you can manually start it by navigating to the installation directory and running the command:

    node spotifyServer.mjs
    • Make sure Node.js is in your system's PATH.

Spicetify Commands

  • To manage customizations, use Spicetify commands in your terminal:
    spicetify backup apply
    spicetify update
    
    These commands allow you to backup your Spotify client, apply new themes, or update configurations.

Custom Keyboard Shortcuts

  • CablespicetifyCLI comes with several custom keyboard shortcuts for Spotify. These shortcuts make it easy to interact with Spotify features (e.g., adding/removing tracks from playlists).

Uninstallation

To remove all customizations and uninstall CablespicetifyCLI:

  1. Restore Spotify to its default settings using Spicetify:
    spicetify restore
    
  2. Delete the CablespicetifyCLI installation folder located at:
    C:\Users\<Your Username>\AppData\Local\cablespicetifycli
    

Troubleshooting

Common Issues

  • Node.js Not Found: Make sure Node.js is installed and added to your system's PATH.
  • Access Token Issues: If the Spotify server (http://localhost:3000) isn’t functioning correctly, check the terminal output for any authorization errors.

Logs and Support

  • Logs are available in the PowerShell window during the installation and while running the local server. Use these logs for debugging issues.
  • For further support, open an issue in the GitHub repository.

License

CablespicetifyCLI is open source and available under the MIT License.

Contributions

Contributions are welcome! Feel free to open pull requests or submit issues to improve the tool.

Stay Connected


Command-line tool to customize the official Spotify client. Supports Windows, MacOS and Linux.

img

Features

  • Change colors whole UI
  • Inject CSS for advanced customization
  • Inject Extensions (Javascript script) to extend functionalities, manipulate UI and control player.
  • Inject Custom apps
  • Remove bloated components to improve performance

Links

About

Command-line tool to customize Spotify client. Supports Windows, MacOS, and Linux.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 72.2%
  • Go 21.4%
  • CSS 4.6%
  • Other 1.8%