Jasima/spotify-dl
1
0
Fork 0
mirror of https://github.com/GuillemCastro/spotify-dl.git synced 2024-11-21 18:00:26 +01:00
Code Issues Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
Guillem Castro 2024-05-11 13:08:07 +02:00
parent 5373f95a19
commit a7adb7b8eb
3 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.lock generated
View file

@ -2303,7 +2303,7 @@ dependencies = [
[[package]] [[package]]
name = "spotify-dl" name = "spotify-dl"
version = "0.2.0" version = "0.2.1"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"async-trait", "async-trait",

2
Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "spotify-dl" name = "spotify-dl"
version = "0.2.0" version = "0.2.1"
authors = ["Guillem Castro <guillemcastro4@gmail.com>"] authors = ["Guillem Castro <guillemcastro4@gmail.com>"]
edition = "2021" edition = "2021"
readme = "README.md" readme = "README.md"

39
README.md
View file

@ -25,30 +25,57 @@ sudo dnf install flac-devel alsa-lib-devel
brew install flac 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 ## Usage
``` ```
spotify-dl 0.1.1 spotify-dl 0.2.0
A commandline utility to download music directly from Spotify A commandline utility to download music directly from Spotify
USAGE: USAGE:
spotify-dl [FLAGS] [OPTIONS] --username <username> [tracks]... spotify-dl [OPTIONS] <tracks>... --username <username>
FLAGS: FLAGS:
-h, --help Prints help information -h, --help Prints help information
-o, --ordered Prefixing the filename with its index in the playlist
-V, --version Prints version information -V, --version Prints version information
OPTIONS: OPTIONS:
-c, --compression <compression> Setting the flac compression level from 0 (fastest, least compression) to -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. 8 (slowest, most compression). A value larger than 8 will be Treated as 8.
Default is 4. Default is 4.
-d, --destination <destination> The directory where the songs will be downloaded [default: .] -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 -p, --password <password> Your Spotify password
-u, --username <username> Your Spotify username -u, --username <username> Your Spotify username
ARGS: ARGS:
<tracks>... A list of Spotify URIs (songs, podcasts or playlists)``` <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`). 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`).
@ -58,4 +85,4 @@ The usage of this software may infringe Spotify's ToS and/or your local legislat
## License ## License
spotify-dl is lic:ewensed under the MIT license. See [LICENSE](LICENSE). spotify-dl is licensed under the MIT license. See [LICENSE](LICENSE).