35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
|
# musidl
|
||
|
|
musidl is a simple command-line utility written in Bash for downloading music from YouTube with id3 tags (used by media players to display the artist, album, etc.). It is licensed under the GNU GPLv3.
|
||
|
|
|
||
|
|
musidl requires [youtube-dl](https://github.com/ytdl-org/youtube-dl) to get information about and download the audio from videos, [jq](https://github.com/stedolan/jq) to process JSON, and [id3v2](http://id3v2.sourceforge.net/) to add id3 tags.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
To install, `git clone` this repository, `cd` into it, and run
|
||
|
|
```sh
|
||
|
|
sudo ln -s $PWD/musidl /usr/local/bin/musidl
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Help information is also available by running `musidl --help`
|
||
|
|
|
||
|
|
Usage: `musidl [options]... [url]... (-- [youtube-dl options])`
|
||
|
|
|
||
|
|
Options:
|
||
|
|
| Flag | Argument | Description |
|
||
|
|
|-------------------|----------|---------------------------------------------------------------|
|
||
|
|
| `-h`, `--help` | | Show help information and exit |
|
||
|
|
| `-v`, `--version` | | Show the version and exit |
|
||
|
|
| `-q`, `--quiet` | | Only print errors |
|
||
|
|
| `-f`, `--format` | <fmt> | The audio format to use (default: mp3) |
|
||
|
|
| `-a`, `--artist` | <name> | The audio format to use (default: mp3) |
|
||
|
|
| `-A`, `--album` | <name> | Set the album title (default: detect from YouTube) |
|
||
|
|
| `-t`, `--song ` | <name> | Set the song title (default: detect from YouTube) |
|
||
|
|
| `-g`, `--genre` | <name> | Set the genre (default: none) |
|
||
|
|
| `-y`, `--year ` | <year> | Set the year (default: detect from YouTube) |
|
||
|
|
| `-T`, `--track` | <track> | Set the track (default: detect from playlist, otherwise none) |
|
||
|
|
| `-s`, `--show ` | | Print information to stdout instead of downloading to file |
|
||
|
|
|
||
|
|
Any arguments after '--' will be sent to youtube-dl directly. These are not officially supported and some may cause problems.
|