-
-
Notifications
You must be signed in to change notification settings - Fork 163
Getting Started
usage: ytmdl [-h] [-q] [--song SONG-METADATA] [--choice CHOICE]
[--artist ARTIST] [--album ALBUM] [--disable-metaadd]
[--skip-meta] [-m] [--proxy URL] [--url URL]
[--list PATH TO LIST] [--nolocal] [--format FORMAT] [--trim]
[--version] [--pl-start NUMBER] [--pl-end NUMBER]
[--pl-items ITEM_SPEC] [--ignore-errors] [--level LEVEL]
[--disable-file] [--list-level]
[SONG_NAME [SONG_NAME ...]]
positional arguments:
SONG_NAME Name of the song to download. Can be an URL to a
playlist as well. It will be automatically recognized.
optional arguments:
-h, --help show this help message and exit
-q, --quiet Don't ask the user to select songs if more than one
search result. The first result in each case will be
considered.
--proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. To enable
SOCKS proxy, specify a proper scheme. For example
socks5://127.0.0.1:1080/. Pass in an empty string
(--proxy "") for direct connection
--url URL Youtube song link.
--list PATH TO LIST Download list of songs. The list should have one song
name in every line.
--nolocal Don't search locally for the song before downloading.
--format FORMAT The format in which the song should be downloaded.
Default is [MP3]. Available options are [m4a]
--trim, -t Trim out the audio from the song. Use underlying
speech and music segmentation engine to determine and
keep only the music in the file. Useful in songs where
there are speeches, noise etc before/after the start
of the song. Default is false.
--version show the program version number and exit
Metadata:
--song SONG-METADATA The song to search in Metadata. Particularly useful
for songs that have the names in a different language
in YouTube. For Example, greek songs.
--choice CHOICE The choice that the user wants to go for. Usefull to
pass along with --quiet. Choices start at 1
--artist ARTIST The name of the song's artist. Pass it with a song
name.
--album ALBUM The name of the song's album. Pass it with a song
name.
--disable-metaadd Disable addition of passed artist and album keyword to
the youtube search in order to get a more accurate
result. (Default: false)
--skip-meta Skip setting the metadata and just copy the converted
song to the destination directory. '--manual-meta'
will override this option, pass only one of them.
-m, --manual-meta Manually enter song details.
Playlist:
--pl-start NUMBER Playlist video to start at (default is 1)
--pl-end NUMBER Playlist video to end at (default is last)
--pl-items ITEM_SPEC Playlist video items to download. Specify indices of
the videos present in the playlist seperated by commas
like: '--playlist-items 1, 2, 4, 6' if you want to
download videos indexed 1, 2, 4 and 6. Range can also
be passed like: '--playlist-items 1-3, 5-7' to
download the videos indexed at 1, 2, 3, 5, 6, 7.
--ignore-errors Ignore if downloading any video fails in a playlist.
If passed, the execution will move to the next video
in the passed playlist.
Logger:
--level LEVEL The level of the logger that will be used while
verbosing. Use `--list-level` to check available
options.
--disable-file Disable logging to files
--list-level List all the available logger levels.The defaults can be changed by editing the config file in ytmdl folder in your .config folder
The config will be created automatically the first time you run ytmdl and will be present in ~/.config/ytmdl/config
However, it can be created manually by the following command
mkdir -p ~/.config/ytmdl; curl https://raw.githubusercontent.com/deepjyoti30/ytmdl/master/examples/config > ~/.config/ytmdl/configAbove command will download the config from the repo and save it in the ~/.config/ytmdl/ directory.
As of the latest development branch, the following options can be changed from the config
| Name | Description | Default |
|---|---|---|
SONG_DIR |
Directory to save the songs in after editing | Current direcotry |
SONG_QUALITY |
Quality of the song | 320kbps |
METADATA_PROVIDERS |
Which API providers to use for metadata | all supported options are used |
DEFAULT_FORMAT |
Default format of the song | mp3 |
SONG_DIR field also takes values that are extracted from the song being downloaded
The SONG_DIR field needs to be passed some special values in order to achieve that. The string is scanned and when a $ sign occurs, the special string will start and each directory can be seperated by using an -> sign.
To save the song in the /dir/<album_name>/<artist_name>/<title>/<song_name>.mp3 format, the following needs to be added in the SONG_DIR field.
SONG_DIR="/dir$Album->Artist->Title"
Above will extract to the following directory structure when a song named Cradles by artist Sub Urban from the album Cradles - Single
|--dir
|--Cradles - Single
|--Sub Urban
|--Cradles
|--Cradles.mp3
In order to pass the name with which the song should be saved, the last attribute can be passed between [].
If the SONG_DIR field is /dir$Album->[Artist] will extract to the following directory structure
|--dir
|--Cradles - Single
|--Sub Urban.mp3
As of the latest source, the following options can be passed to the special string in order to create dynamic directories
| Name | |
|---|---|
Artist |
Artist Of the Song |
Album |
Album Of the Song |
Title |
Title Of the Song |
Genre |
Genre Of the Song |
TrackNumber |
TrackNumber Of the Song |
ReleaseDate |
ReleaseDate Of the Song |