diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -6,6 +6,33 @@ Personal script to when downloading music with youtube-dl, tagging the files (ar ## Installation Right now, the easiest thing to do is just use it from this repo. +## Usage +Output from using the "--help" option: +``` +usage: jamos [-h] [-c cookiefile.txt] [-o output_directory] [-r jamos_failed_urls.txt] [https://music.youtube.com/playlist?list=1234] + +Download songs from YouTube Music + +positional arguments: + https://music.youtube.com/playlist?list=1234 + Playlist or Song URL to download. + +optional arguments: + -h, --help show this help message and exit + -c cookiefile.txt, --cookies cookiefile.txt + Cookie file to use. + -o output_directory, --output output_directory + Output directory to use + -r jamos_failed_urls.txt, --retryFile jamos_failed_urls.txt + Output directory to use + +``` + +The most common usage (aka tldr) would probably be something like: +``` +$ jamos "https://music.youtube.com/playlist/1234" -o "/home/jackson/Music" +``` + ## TODO - Installation - Add necessary files to install via pip @@ -13,4 +40,4 @@ Right now, the easiest thing to do is just use it from this repo. - Configuration - Config file in XDG directory - URL file in XDG directory - - Command line parameters + - [Done] Command line parameters |