44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
# shanty-dl
|
|
|
|
Music downloading for [Shanty](ssh://connor@git.rcjohnstone.com:2222/Shanty/shanty.git).
|
|
|
|
Downloads music files using pluggable backends. The default backend uses yt-dlp with
|
|
YouTube Music search, rate limiting, and configurable output format.
|
|
|
|
## Prerequisites
|
|
|
|
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) must be installed and on PATH
|
|
- [ffmpeg](https://ffmpeg.org/) for audio conversion
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
# Download a single song
|
|
shanty-dl download "Pink Floyd Time"
|
|
|
|
# Download from a direct URL
|
|
shanty-dl download "https://www.youtube.com/watch?v=..."
|
|
|
|
# Add to download queue
|
|
shanty-dl queue add "Radiohead Creep"
|
|
|
|
# Process the queue
|
|
shanty-dl queue process
|
|
|
|
# List queue status
|
|
shanty-dl queue list
|
|
|
|
# Retry failed downloads
|
|
shanty-dl queue retry
|
|
```
|
|
|
|
## YouTube Authentication
|
|
|
|
For higher rate limits (2000/hr vs 500/hr), export cookies:
|
|
|
|
```sh
|
|
yt-dlp --cookies-from-browser firefox --cookies ~/.config/shanty/cookies.txt
|
|
```
|
|
|
|
Then pass via `--cookies ~/.config/shanty/cookies.txt` or set `SHANTY_COOKIES`.
|