spotify-dl/README.md
2024-05-11 13:08:07 +02:00

88 lines
2.2 KiB
Markdown

# spotify-dl
A command line utility to download songs, podcasts, playlists and albums directly from Spotify's servers.
You need a Spotify Premium account.
## Dependencies
spotify-dl depends on libflac
### Debian-based distros
```
sudo apt install libflac-dev libasound2-dev
```
### Red Hat-based distros
```
sudo dnf install flac-devel alsa-lib-devel
```
### MacOSX
```
brew install flac
```
## Installation
Before installation, make sure all dependencies are installed for your platform.
### Using `cargo`
```
cargo install spotify-dl
```
### Using homebrew
```
brew tap guillemcastro/spotify-dl
brew install spotify-dl
```
### From source
```
git clone https://github.com/GuillemCastro/spotify-dl.git
cd spotify-dl
cargo build --release
cargo install --path .
```
## Usage
```
spotify-dl 0.2.0
A commandline utility to download music directly from Spotify
USAGE:
spotify-dl [OPTIONS] <tracks>... --username <username>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --compression <compression> Setting the flac compression level from 0 (fastest, least compression) to
8 (slowest, most compression). A value larger than 8 will be Treated as 8.
Default is 4.
-d, --destination <destination> The directory where the songs will be downloaded
-t, --parallel <parallel> Number of parallel downloads. Default is 5. [default: 5]
-p, --password <password> Your Spotify password
-u, --username <username> Your Spotify username
ARGS:
<tracks>... A list of Spotify URIs or URLs (songs, podcasts, playlists or albums)
```
Songs, playlists and albums must be passed as Spotify URIs or URLs (e.g. `spotify:track:123456789abcdefghABCDEF` for songs and `spotify:playlist:123456789abcdefghABCDEF` for playlists or `https://open.spotify.com/playlist/123456789abcdefghABCDEF?si=1234567890`).
## Disclaimer
The usage of this software may infringe Spotify's ToS and/or your local legislation. Use it under your own risk.
## License
spotify-dl is licensed under the MIT license. See [LICENSE](LICENSE).