Files
SpotX-Bash/README.md
2026-03-26 17:47:14 -04:00

101 lines
4.0 KiB
Markdown

<p align="center">
<a href="https://github.com/jetfir3/SpotX-Bash"><img src="https://spotx-official.github.io/images/logos/logo_sxb.png" />
</p>
<p align="center">
<a href="https://github.com/amd64fox/SpotX"><img src="https://spotx-official.github.io/images/shields/spotx-win_sxb.svg"></a>
<a href="https://t.me/SpotxCommunity"><img src="https://spotx-official.github.io/images/shields/SpotX_Community.svg"></a>
</p>
***
<center>
<h4 align="center">Adblock for the Spotify desktop client on Linux & macOS</h4>
<p align="center">
<strong>Latest supported version:</strong> 1.2.86.502.g8cd7fb22
</p>
</center>
### 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` / `--premium` flag
- macOS client auto-updates are NOT disabled, block auto-updates with `-B` / `--blockupdates` flag
- View additional flags/options and examples in the `Options` section below
- For more information, see the [FAQ](https://github.com/SpotX-Official/SpotX-Bash/wiki/SpotX%E2%80%90Bash-FAQ)
### Options:
<details>
<summary>Click to expand!</summary>
| Option | Description |
| --- | --- |
| `-B` | block client auto-updates [macOS] |
| `-c` | clear client app cache |
| `-d` | enable [developer mode](https://github.com/SpotX-Official/SpotX-Bash/wiki/SpotX%E2%80%90Bash-FAQ#what-is-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](https://github.com/SpotX-Official/SpotX-Bash/issues/20#issuecomment-1762040019) |
| `--nocolor` | remove colors from SpotX-Bash output |
| `-o` | use [old home screen UI](https://github.com/SpotX-Official/SpotX-Bash/wiki/SpotX%E2%80%90Bash-FAQ#what-is-the-old-and-new-ui) |
| `-p` | [paid premium-tier subscriber](https://github.com/SpotX-Official/SpotX-Bash/wiki/SpotX%E2%80%90Bash-FAQ#can-spotx-bash-be-used-with-a-paid-premium-account) |
| `-P <path>` | set path to client |
| `--rollback` | install previous supported client version [macOS] |
| `-S` | skip [codesigning](https://github.com/SpotX-Official/SpotX-Bash/discussions/3) [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) -cdh
```
**Run 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) -p
```
**Run SpotX-Bash, install latest testing branch client version (Linux)**
```
bash <(curl -sSL https://spotx-official.github.io/run.sh) --installdeb
```
**Run SpotX-Bash, block auto-updates, install latest supported client version (macOS)**
```
bash <(curl -sSL https://spotx-official.github.io/run.sh) -B --installmac
```
</details>
### Thanks:
- [amd64fox](https://github.com/amd64fox/) of [SpotX](https://github.com/SpotX-Official/SpotX)