Technical Documentation: SpotX-Official/SpotX-Bash
ℹ️ Provenance: Hybrid Fusion:
SpotX-Official/SpotX-Bash(README + 1 In-Tree Chapters) · CodeWiki Reference · Recency: Active (< 180 days)
1. Project Overview & Quickstart (SpotX-Official/SpotX-Bash)
<h4 align="center">Adblock for the Spotify desktop client on Linux & macOS</h4>Features:
- Block all audio, banner & video ads
- Block logging
- Enable developer mode
- Enable experimental features
- Hide audiobooks, episodes & podcasts on home screen
- Block automatic updates (macOS)
- Install latest desktop client versions on macOS and APT-based Linux distros
- Supports all Linux distros and OS X/macOS 10.11+
Usage:
- Run the following command in terminal:
bash <(curl -sSL https://spotx-official.github.io/run.sh)or
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-Official/SpotX-Bash/main/spotx.sh)- By default...
- all supported experimental features are enabled
- free-tier user patches are applied, paid-premium users should use
-p/--premiumflag - macOS client auto-updates are NOT disabled, block auto-updates with
-B/--blockupdatesflag
- View additional flags/options and examples in the
Optionssection below - For more information, see the FAQ
Snap / NixOS:
Spotify installations using Snap require the included spotx-snap.sh helper. Download the repo so spotx-snap.sh and spotx.sh remain in the same directory:
git clone https://github.com/SpotX-Official/SpotX-Bash.git
cd SpotX-Bash
bash spotx-snap.shRun bash spotx-snap.sh --help for additional Snap options or see the FAQ.
NixOS users should use SpotX-Nix, which applies SpotX-Bash while building the Spotify package without modifying the Nix store.
Options:
Click to expand!
| Option | Description |
|---|---|
-B |
block client auto-updates [macOS] |
-c |
clear client app cache |
-d |
enable developer mode |
-e |
exclude all experimental features |
-f |
force SpotX-Bash to run |
-h |
hide non-music on home screen |
--help |
print options |
-i |
enable interactive mode |
--installdeb |
install latest client deb pkg on APT-based distros [Linux] |
--installmac |
install latest supported client [macOS] |
-l |
set lyrics background color to black |
--nocolor |
remove colors from SpotX-Bash output |
-o |
use old home screen UI |
-p |
paid premium-tier subscriber |
-P |
set path to client |
--rollback |
install previous supported client version [macOS] |
-S |
skip codesigning [macOS] |
--stable |
use with '--installdeb' for stable branch [Linux] |
--uninstall |
uninstall SpotX-Bash |
-v |
print SpotX-Bash version |
Examples:
Run SpotX-Bash, clear app cache, enable dev mode, hide non-music categories
bash <(curl -sSL https://spotx-official.github.io/run.sh) -cdhRun SpotX-Bash, enable interactive mode, set custom path to client
bash <(curl -sSL https://spotx-official.github.io/run.sh) -i -P $HOME/Downloads/Run SpotX-Bash, set paid premium-tier subscriber
bash <(curl -sSL https://spotx-official.github.io/run.sh) -pRun SpotX-Bash, install latest testing branch client version (Linux)
bash <(curl -sSL https://spotx-official.github.io/run.sh) --installdebRun SpotX-Bash, block auto-updates, install latest supported client version (macOS)
bash <(curl -sSL https://spotx-official.github.io/run.sh) -B --installmacThanks:
2. In-Tree Documentation Chapters (SpotX-Official/SpotX-Bash)
<h4 align="center">Adblock for the Spotify desktop client on Linux & macOS</h4>Features:
- Block all audio, banner & video ads
- Block logging
- Enable developer mode
- Enable experimental features
- Hide audiobooks, episodes & podcasts on home screen
- Block automatic updates (macOS)
- Install latest desktop client versions on macOS and APT-based Linux distros
- Supports all Linux distros and OS X/macOS 10.11+
Usage:
- Run the following command in terminal:
bash <(curl -sSL https://spotx-official.github.io/run.sh)or
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-Official/SpotX-Bash/main/spotx.sh)- By default...
- all supported experimental features are enabled
- free-tier user patches are applied, paid-premium users should use
-p/--premiumflag - macOS client auto-updates are NOT disabled, block auto-updates with
-B/--blockupdatesflag
- View additional flags/options and examples in the
Optionssection below - For more information, see the FAQ
Snap / NixOS:
Spotify installations using Snap require the included spotx-snap.sh helper. Download the repo so spotx-snap.sh and spotx.sh remain in the same directory:
git clone https://github.com/SpotX-Official/SpotX-Bash.git
cd SpotX-Bash
bash spotx-snap.shRun bash spotx-snap.sh --help for additional Snap options or see the FAQ.
NixOS users should use SpotX-Nix, which applies SpotX-Bash while building the Spotify package without modifying the Nix store.
Options:
Click to expand!
| Option | Description |
|---|---|
-B |
block client auto-updates [macOS] |
-c |
clear client app cache |
-d |
enable developer mode |
-e |
exclude all experimental features |
-f |
force SpotX-Bash to run |
-h |
hide non-music on home screen |
--help |
print options |
-i |
enable interactive mode |
--installdeb |
install latest client deb pkg on APT-based distros [Linux] |
--installmac |
install latest supported client [macOS] |
-l |
set lyrics background color to black |
--nocolor |
remove colors from SpotX-Bash output |
-o |
use old home screen UI |
-p |
paid premium-tier subscriber |
-P |
set path to client |
--rollback |
install previous supported client version [macOS] |
-S |
skip codesigning [macOS] |
--stable |
use with '--installdeb' for stable branch [Linux] |
--uninstall |
uninstall SpotX-Bash |
-v |
print SpotX-Bash version |
Examples:
Run SpotX-Bash, clear app cache, enable dev mode, hide non-music categories
bash <(curl -sSL https://spotx-official.github.io/run.sh) -cdhRun SpotX-Bash, enable interactive mode, set custom path to client
bash <(curl -sSL https://spotx-official.github.io/run.sh) -i -P $HOME/Downloads/Run SpotX-Bash, set paid premium-tier subscriber
bash <(curl -sSL https://spotx-official.github.io/run.sh) -pRun SpotX-Bash, install latest testing branch client version (Linux)
bash <(curl -sSL https://spotx-official.github.io/run.sh) --installdebRun SpotX-Bash, block auto-updates, install latest supported client version (macOS)
bash <(curl -sSL https://spotx-official.github.io/run.sh) -B --installmacThanks:
--- METRICS ---
- Files Extracted: 2
- Estimated Token Budget: ~2103 tokens
- Recency Window: Active (< 180 days)
- Canonical Reference: https://codewiki.google/github.com/SpotX-Official/SpotX-Bash