-
Notifications
You must be signed in to change notification settings - Fork 0
v0.6
This version is not released yet
This page describes an unreleased version. The information could be out of date or change completely until this version will be released
Show Usage: Only the custom options of a command will be shown (due to a clear view)
Perform multiple xspf operations defined by a .yml file. The batch command will delegate all commands defined in the YAML file to other commands
Show Usage
Usage:
batch [options] [--] <file>
Arguments:
file A .yml file
Options:
--validate Validate the batch file instead of executing it
--example Create an example batch file
Help:
Perform multiple xspf operations as a batch
Example File
Example batch file: Test.yml
# Family Videos
-
command: create
"playlist-file": "FamilyVideos.xspf"
"file-or-folder": "/Videos/Family"
"-b": ['*.db', '*.jpg']
-
command: order
"order-type": asc
"playlist-file": "FamilyVideos.xspf"
# Fun Videos
-
command: create
"playlist-file": "Fun.xspf"
"file-or-folder": "/Videos/Fun"
"-w": ['*.mp4']
-
command: order
"order-type": random
"playlist-file": "Fun.xspf"Same functionality as the batch command but allows multiple YAML files to be processed concurrently. This command provides no validation and no example fucntionality (unlike batch).
Every file will be processed in its own process. This command will not work if forking is not supported by the host system.
Show Usage
Usage:
batch:concurrent [<files>]...
Arguments:
files .yml files
Help:
Perform multiple xspf operations from multiple batch files concurrently
Create a .xspf playlist file
Show Usage
Usage:
create [options] [--] <playlist-file> <file-or-folder> (<file-or-folder>)...
Arguments:
playlist-file The playlist file that should be created
file-or-folder Files and folders that should be added
Options:
-w, --whitelist=WHITELIST Whitelisted file patterns (e.g. *.avi) (multiple values allowed)
-b, --blacklist=BLACKLIST Blacklisted file patterns (e.g. *.db) (multiple values allowed)
Help:
Create a new playlist
Merge multiple .xspf playlists into a single playlist
Show Usage
Usage:
merge [options] [--] <target> [<source>]...
Arguments:
target The target file which will contain all the tracks from the other files
source The source files
Options:
-u, --unique Filter duplicate tracks
Help:
Merge multiple playlists into one single file
Order a .xspf playlist
Available order types:
asc
All entries in the playlist will be sorted by their file name (not path) in ascending order
desc
Same as asc but in opposite order
random
All entries will be sorted in a random order
Show Usage
Usage:
order [<order-type>] [<playlist-file>]
Arguments:
order-type The order type
playlist-file The playlist file
Options:
Help:
Orders the given playlist using the given order type
Update the xspf.phar to the latest version (if a newer version is available). All updates will be downloaded from github.com releases
Show Usage
Usage:
self-update [options]
Options:
-f, --force Force update
Help:
Replace the current version of xspf with the latest from GitHub
Validate the given playlist files. Check for files that don't exist and remove them from the playlist
Show Usage
Usage:
validate [options] [--] <playlist-file>
Arguments:
playlist-file The playlist file
Options:
--stop-on-error If the command should stop on the first error
Help:
Checks if all files in the playlist exist and removes the missing files
Display the current version of the xspf.phar
Show Usage
Usage:
version
Options:
Help:
Display the version of this xspf-tools
Copy a file from source to target. The purpose of this command is to improve the usability of the batch command
Show Usage
Usage:
copy [options] [--] <source> <target>
Arguments:
source
target
Options:
-f, --force Force override of existing files
Help:
A simple copy functionality
Convert an index file into a .xspf playlist
Show Usage
Usage:
index:convert [options] [--] [<index-file>] [<playlist-file>]
Arguments:
index-file The index file [default: "index.xdc"]
playlist-file The playlist file that should be created [default: "index.xspf"]
Options:
-t, --distinct Avoid duplicates in playlist file
-D, --delete Remove index file after conversion
Help:
Convert an index file into a playlist file
Create an index file.
An index is a simple mechanism for saving blueprints of a playlist file. Index files use a relative path instead of an absolute path. This increases the portability if e.g. a root path (or drive letter on windows) changes.
Show Usage
Usage:
index:create [options] [--] <file-or-folder> (<file-or-folder>)...
Arguments:
file-or-folder Files and folders that should be added
Options:
-o, --output=OUTPUT The path of the file [default: "index.xdc"]
--no-progress Suppress the progressbar
-a, --append Append to index instead of overriding it
Help:
This command creates an index file used by various other xspf-tools commands
Index files can be used to dynamically create playlist files (e.g. if you use
Windows and Linux the paths of the files may be inconsistent. The index file
stores all paths relative to provide cross-system-support)
Order an index file (just like order but for index files)
Show Usage
Usage:
index:order [options] [--] [<order-type>] [<index-file>]
Arguments:
order-type The order type
index-file The index file [default: "index.xdc"]
Options:
-t, --distinct Remove duplicates from index file
Help:
Orders an index file