mirror/slsk-batchdl
1
0
Fork 0
mirror of https://github.com/fiso64/slsk-batchdl.git synced 2024-12-22 14:32:40 +00:00
Code Issues Activity

readme

Browse source
This commit is contained in:
fiso64 2024-10-05 11:40:13 +02:00
parent 317ff262c3
commit b1e8dcd535
2 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
README.md
View file

@ -41,51 +41,51 @@ Usage: sldl <input> [OPTIONS]
``` ```
``` ```
General Options General Options
-p, --path <path> Download directory -p, --path <path> Download directory
--input-type <type> [csv|youtube|spotify|bandcamp|string|list] --input-type <type> [csv|youtube|spotify|bandcamp|string|list]
--name-format <format> Name format for downloaded tracks. See --help name-format --name-format <format> Name format for downloaded tracks. See --help name-format
-n, --number <maxtracks> Download the first n tracks of a playlist -n, --number <maxtracks> Download the first n tracks of a playlist
-o, --offset <offset> Skip a specified number of tracks -o, --offset <offset> Skip a specified number of tracks
-r, --reverse Download tracks in reverse order -r, --reverse Download tracks in reverse order
-c, --config <path> Set config file location. Set to 'none' to ignore config -c, --config <path> Set config file location. Set to 'none' to ignore config
--profile <names> Configuration profile(s) to use. See --help ""config"". --profile <names> Configuration profile(s) to use. See --help ""config"".
--concurrent-downloads <num> Max concurrent downloads (default: 2) --concurrent-downloads <num> Max concurrent downloads (default: 2)
--m3u <option> Create an m3u8 playlist file in the output directory --m3u <option> Create an m3u playlist file in the output directory
'none' (default for string inputs): Do not create 'none' (default for string inputs): Do not create
'index' (default): Write a single line for sldl to index 'index'(default): Write a single line for sldl to index
all downloaded files, required for skip-existing=m3u downloaded files. Required for skip-existing=m3u.
'all': Write the index and a list of paths and fails 'all': Create a playable m3u playlist file and sldl index.
--m3u-path <path> Override default m3u path --m3u-path <path> Override default m3u path
-s, --skip-existing Skip if a track matching file conditions is found in the -s, --skip-existing Skip if a track matching file conditions is found in the
output folder or your music library (if provided) output folder or your music library (if provided)
--skip-mode <mode> [name|tag|m3u|name-cond|tag-cond|m3u-cond] --skip-mode <mode> [name|tag|m3u|name-cond|tag-cond|m3u-cond]. See --help
See --help ""skip-existing"". skip-existing.
--music-dir <path> Specify to also skip downloading tracks found in a music --music-dir <path> Specify to also skip downloading tracks found in a music
library. Use with --skip-existing library. Use with --skip-existing
--skip-not-found Skip searching for tracks that weren't found on Soulseek --skip-not-found Skip searching for tracks that weren't found on Soulseek
during the last run. Fails are read from the m3u file. during the last run. Fails are read from the m3u file.
--skip-existing-pref-cond Use preferred instead of necessary conds for skip-existing --skip-existing-pref-cond Use preferred instead of necessary conds for skip-existing
--listen-port <port> Port for incoming connections (default: 49998) --listen-port <port> Port for incoming connections (default: 49998)
--on-complete <command> Run a command whenever a file is downloaded. --on-complete <command> Run a command whenever a file is downloaded.
Available placeholders: {path} (local save path), {title}, Available placeholders: {path} (local save path), {title},
{artist},{album},{uri},{length},{failure-reason},{state}. {artist},{album},{uri},{length},{failure-reason},{state}.
Prepend a state number to only download in specific cases: Prepend a state number to only run in specific cases:
1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and 1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and
NotFoundLastTime states respectively. NotFoundLastTime states respectively.
E.g: '1:<cmd>' will only run the command if the file is E.g: '1:<cmd>' will only run the command if the file is
downloaded successfully. Prepend 's:' to use the system downloaded successfully. Prepend 's:' to use the system
shell to execute the command. shell to execute the command.
--print <option> Print tracks or search results instead of downloading: --print <option> Print tracks or search results instead of downloading:
'tracks': Print all tracks to be downloaded 'tracks': Print all tracks to be downloaded
'tracks-full': Print extended information about all tracks 'tracks-full': Print extended information about all tracks
'results': Print search results satisfying file conditions 'results': Print search results satisfying file conditions
'results-full': Print search results including full paths 'results-full': Print search results including full paths.
--no-progress Disable progress bars/percentages, only simple printing --no-progress Disable progress bars/percentages, only simple printing
--debug Print extra debug info --debug Print extra debug info
``` ```
``` ```
Searching Searching

16
slsk-batchdl/Help.cs
View file

@ -28,17 +28,17 @@ public static class Help
-c, --config <path> Set config file location. Set to 'none' to ignore config -c, --config <path> Set config file location. Set to 'none' to ignore config
--profile <names> Configuration profile(s) to use. See --help ""config"". --profile <names> Configuration profile(s) to use. See --help ""config"".
--concurrent-downloads <num> Max concurrent downloads (default: 2) --concurrent-downloads <num> Max concurrent downloads (default: 2)
--m3u <option> Create an m3u8 playlist file in the output directory --m3u <option> Create an m3u playlist file in the output directory
'none' (default for string inputs): Do not create 'none' (default for string inputs): Do not create
'index' (default): Write a single line for sldl to index 'index'(default): Write a single line for sldl to index
all downloaded files, required for skip-existing=m3u downloaded files. Required for skip-existing=m3u.
'all': Write the index and a list of paths and fails 'all': Create a playable m3u playlist file and sldl index.
--m3u-path <path> Override default m3u path --m3u-path <path> Override default m3u path
-s, --skip-existing Skip if a track matching file conditions is found in the -s, --skip-existing Skip if a track matching file conditions is found in the
output folder or your music library (if provided) output folder or your music library (if provided)
--skip-mode <mode> [name|tag|m3u|name-cond|tag-cond|m3u-cond] --skip-mode <mode> [name|tag|m3u|name-cond|tag-cond|m3u-cond]. See --help
See --help ""skip-existing"". skip-existing.
--music-dir <path> Specify to also skip downloading tracks found in a music --music-dir <path> Specify to also skip downloading tracks found in a music
library. Use with --skip-existing library. Use with --skip-existing
--skip-not-found Skip searching for tracks that weren't found on Soulseek --skip-not-found Skip searching for tracks that weren't found on Soulseek
@ -49,7 +49,7 @@ public static class Help
--on-complete <command> Run a command whenever a file is downloaded. --on-complete <command> Run a command whenever a file is downloaded.
Available placeholders: {path} (local save path), {title}, Available placeholders: {path} (local save path), {title},
{artist},{album},{uri},{length},{failure-reason},{state}. {artist},{album},{uri},{length},{failure-reason},{state}.
Prepend a state number to only download in specific cases: Prepend a state number to only run in specific cases:
1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and 1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and
NotFoundLastTime states respectively. NotFoundLastTime states respectively.
E.g: '1:<cmd>' will only run the command if the file is E.g: '1:<cmd>' will only run the command if the file is
@ -60,7 +60,7 @@ public static class Help
'tracks': Print all tracks to be downloaded 'tracks': Print all tracks to be downloaded
'tracks-full': Print extended information about all tracks 'tracks-full': Print extended information about all tracks
'results': Print search results satisfying file conditions 'results': Print search results satisfying file conditions
'results-full': Print search results including full paths 'results-full': Print search results including full paths.
--no-progress Disable progress bars/percentages, only simple printing --no-progress Disable progress bars/percentages, only simple printing
--debug Print extra debug info --debug Print extra debug info