Repository: spotDL/spotify-downloader

Stars: 24503

README.md Copy Chapter

<!--- mdformat-toc start --slug=github --->

<!---
!!! IF EDITING THE README, ENSURE TO COPY THE WHOLE FILE TO index.md in /docs/ AND REMOVE THE REFERENCES TO ReadTheDocs THERE.
--->

<div align="center">

spotDL v4

spotDL finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.

!Contributors

spotDL: The fastest, easiest and most accurate command-line music downloader.

______________________________________________________________________
Read the documentation on ReadTheDocs!
______________________________________________________________________

Installation Copy Chapter

Refer to our Installation Guide for more details.

Python (Recommended Method) Copy Section

- _spotDL_ can be installed by running pip install spotdl.
- To update spotDL run pip install --upgrade spotdl

> On some systems you might have to change pip to pip3.

<details>
<summary style="font-size:1.25em"><strong>Other options</strong></summary>

- Prebuilt executable
- You can download the latest version from the
Releases Tab
- On Termux
- curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh
- Arch
- There is an Arch User Repository (AUR) package for
spotDL.
- Docker
- Build image:

docker build -t spotdl .

- Launch container with spotDL parameters (see section below). You need to create mapped
volume to access song files

docker run --rm -v $(pwd):/music spotdl download [trackUrl]

- Build from source

git clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader
    pip install uv
    uv sync
    uv run scripts/build.py

An executable is created in spotify-downloader/dist/.

</details>

Installing FFmpeg Copy Section

FFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory:
spotdl --download-ffmpeg

We recommend the above option, but if you want to install FFmpeg system-wide,
follow these instructions

- Windows Tutorial
- OSX - brew install ffmpeg
- Linux - sudo apt install ffmpeg or use your distro's package manager

Usage Copy Chapter

Using SpotDL without options:

spotdl [urls]

You can run _spotDL_ as a package if running it as a script doesn't work:

python -m spotdl [urls]

General usage:

spotdl [operation] [options] QUERY

There are different operations spotDL can perform. The _default_ is download, which simply downloads the songs from YouTube and embeds metadata.

The query for spotDL is usually a list of Spotify URLs, but for some operations like sync, only a single link or file is required.
For a list of all options use ``spotdl -h`

<details>
<summary style="font-size:1em"><strong>Supported operations</strong></summary>

- save: Saves only the metadata from Spotify without downloading anything.
- Usage:
spotdl save [query] --save-file {filename}.spotdl

- web: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading individual songs.

- url: Get user-friendly URL for each song from the query.
- Usage:
spotdl url [query]

- sync: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.

- Usage:
spotdl sync [query] --save-file {filename}.spotdl

This creates a new sync file. To update the directory in the future, use:

spotdl sync {filename}.spotdl

- meta`: Updates metadata for the provided song files.

</details>

Music Sourcing and Audio Quality Copy Chapter

spotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.

Note

Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.

Audio Quality Copy Section

spotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.

Check the Audio Formats page for more info.

Contributing Copy Chapter

Interested in contributing? Check out our CONTRIBUTING.md to find
resources around contributing along with a guide on how to set up a development environment.

Join our amazing community as a code contributor Copy Section

<a href="https://github.com/spotDL/spotify-downloader/graphs/contributors">
<img class="dark-light" src="https://contrib.rocks/image?repo=spotDL/spotify-downloader&anon=0&columns=25&max=100&r=true" />
</a>

License Copy Chapter

This project is Licensed under the MIT License.