Back to Spotify Downloader

spotDL v4

docs/index.md

4.5.05.4 KB
Original Source
<!--- 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. !!! ENSURE TO UPDATE LINKS AND REMOVE HTML FORMATTING --->

spotDL v4

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

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

Installation

Refer to our Installation Guide for more details.

  • 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.

Other options

  • Prebuilt executable

  • On Termux

    • curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh
  • Arch

  • Docker

    • Build image:

      bash
      docker build -t spotdl .
      
    • Launch container with spotDL parameters (see section below). You need to create mapped volume to access song files

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

      If you bind-mount $(pwd):/music, that host directory must be writable by the container UID/GID.

    • Use Docker Compose if you want Docker to manage permissions for you:

      bash
      # Set your user ID and group ID (recommended)
      # This ensures downloaded files are owned by your user instead of root
      # If you don't set this, files will be owned by user 1000
      export PUID=$(id -u)
      export PGID=$(id -g)
      
      # Build and download
      docker compose build
      docker compose run --rm spotdl download [trackUrl]
      

      Docker Compose mounts spotdl_music:/music and stores downloads in that volume. Export files:

      bash
      docker compose up --no-start spotdl
      mkdir -p downloads
      docker compose cp spotdl:/music/. ./downloads/
      
  • Build from source

    bash
    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/.

Installing FFmpeg

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

Using SpotDL without options:

sh
spotdl [urls]

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

sh
python -m spotdl [urls]

General usage:

sh
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

Refer to Usage for more info.

Music Sourcing and Audio Quality

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

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

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

<a href="https://github.com/spotDL/spotify-downloader/graphs/contributors"> </a>

License

This project is Licensed under the MIT License.