This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Console Client

Documentation about how to use the console client.

1: Manual

This section contains the documentation about the PersonalMediaVault console client.

The PersonalMediaVault console client is a CLI application developed in the Rust programming language that can be used to interact with the PersonalMediaVault server without a GUI environment or inside shell scripts.

Download

In order to download the tool, go to the Releases and download the binary for your system

You can find its source code at the pmv-cli repository. You can compile it yourself following the instructions provided in the README document.

Usage

In order to use the tool, place the binary inside a folder in your PATH environment variable.

Run the tool help command to see the manual:

pmv-cli --help

For more information, check the Manual

1 - Manual

Manual for the PersonalMediaVault console client.

This is the manual for the PersonalMediaVault console client.

Usage:

pmv-cli [OPTIONS] <COMMAND>

Commands:

Command	Description
login	Logins into an active vault, printing a session URL into the standard output
logout	Closes the active session, given a session URL
account	Manages accounts
media	Manages media assets
random	Retrieves random media assets from the vault
search	Searches for media assets in the vault (Basic)
advanced-search	Searches for media assets in the vault (Advanced)
tag	Manages tags
album	Manages albums
config	Manages vault configuration
task	Retrieves tasks information
invites	Manages invites
batch	Applies a batch operation to a list of media assets
get-server-information	Gets server information, like the version it is using

Options:

Option	Description
`-u, --vault-url <VAULT_URL>`	HTTP connection URL to the active vault
`-d, --debug`	Turn debug messages on
`-y, --yes`	Auto confirm actions
`-h, --help`	Print help
`-V, --version`	Print version

Logins into an active vault, printing a session URL into the standard output

Usage:

pmv-cli login [OPTIONS]

Options:

Option	Description
`-U, --username <USERNAME>`	Vault username. You can also specify the credentials in the URL
`-D, --duration <DURATION>`	Session duration. Can be: day, week, month or year
`-I, --invite-code <INVITE_CODE>`	Invite code. Setting this option will ignore the credentials and use the code
`-h, --help`	Print help

Command: logout

Closes the active session, given a session URL

Usage:

pmv-cli logout

Options:

Option	Description
`-h, --help`	Print help

Command: account

Manages accounts

Usage:

pmv-cli account <COMMAND>

Commands:

Command	Description
context	Prints account context to the standard output
change-username	Changes username (only for root account)
change-password	Changes account password
list	List accounts
create	Creates new account
delete	Deletes an existing account

Options:

Option	Description
`-h, --help`	Print help

Command: account context

Prints account context to the standard output

Usage:

pmv-cli account context

Options:

Option	Description
`-h, --help`	Print help

Command: account change-username

Changes username (only for root account)

Usage:

pmv-cli account change-username <USERNAME>

Arguments:

Argument	Description
`<USERNAME>`	Username to change into

Options:

Option	Description
`-h, --help`	Print help

Command: account change-password

Changes account password

Usage:

pmv-cli account change-password

Options:

Option	Description
`-h, --help`	Print help

Command: account list

List accounts

Usage:

pmv-cli account list [OPTIONS]

Options:

Option	Description
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: account create

Creates new account

Usage:

pmv-cli account create [OPTIONS] <USERNAME>

Arguments:

Argument	Description
`<USERNAME>`	Username for the new account

Options:

Option	Description
`-a, --allow-write`	Allows the new account to modify the vault
`-h, --help`	Print help

Command: account delete

Deletes an existing account

Usage:

pmv-cli account delete <USERNAME>

Arguments:

Argument	Description
`<USERNAME>`	Username of the account to delete

Options:

Option	Description
`-h, --help`	Print help

Command: media

Manages media assets

Usage:

pmv-cli media <COMMAND>

Commands:

Command	Description
get	Gets media asset metadata and download links
stats	Gets media asset size stats
download	Downloads a media asset
export	Exports a media asset, downloading everything (metadata + assets) into a folder
upload	Uploads a new media asset, waits for encryption and adds tags if specified
import	Imports a media asset, expecting a folder with the same format the export command uses
set-title	Changes the title of a media asset
set-description	Changes the description of a media asset
set-extended-description	Changes the extended description of a media asset
set-force-start-beginning	Changes the forced start from beginning parameter of a media asset
set-is-animation	Changes the is-animation parameter of a media asset
set-thumbnail	Sets the thumbnail of a media asset
get-time-slices	Prints the time slices of a media asset
set-time-slices	Sets the time slices of a media asset
set-image-notes	Sets the image notes of a media asset
add-resolution	Adds new resolution to the media asset
remove-resolution	Removes a resolution from the media asset
add-subtitle	Adds subtitle file to a media asset
rename-subtitle	Renames a subtitles file
remove-subtitle	Removes subtitle file from a media asset
add-audio	Adds audio track file to a media asset
rename-audio	Renames an audio track file
remove-audio	Removes audio track file from a media asset
add-attachment	Adds attachment file
rename-attachment	Renames attachment file
remove-attachment	Removes attachment file
re-encode	Re-Encodes a media asset
replace	Replaces the media asset with another file
delete	Deletes a media asset

Options:

Option	Description
`-h, --help`	Print help

Command: media get

Gets media asset metadata and download links

Usage:

pmv-cli media get <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: media stats

Gets media asset size stats

Usage:

pmv-cli media stats <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: media download

Downloads a media asset

Usage:

pmv-cli media download [OPTIONS] <MEDIA> [ASSET]

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`[ASSET]`	Asset to download. Examples: original, thumbnail, resolution:1280x720:30, sub:ID, audio:ID, attachment:ID, notes, preview:Index, ext_desc

Options:

Option	Description
`-o, --output <OUTPUT>`	Path to the file to download the asset into
`-p, --print-link`	Prints the download link, instead of downloading to a file
`-h, --help`	Print help

Command: media export

Exports a media asset, downloading everything (metadata + assets) into a folder

Usage:

pmv-cli media export [OPTIONS] <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-o, --output <OUTPUT>`	Path to the folder to download the files into
`-h, --help`	Print help

Command: media upload

Uploads a new media asset, waits for encryption and adds tags if specified

Usage:

pmv-cli media upload [OPTIONS] <PATH>

Arguments:

Argument	Description
`<PATH>`	Path to the file to upload

Options:

Option	Description
`-t, --title <TITLE>`	A title for the media asset
`-a, --album <ALBUM>`	Album to upload the media asset into
`-T, --tags <TAGS>`	Tags to add to the media asset, separated by spaces
`-s, --skip-encryption`	Do not wait for encryption
`-h, --help`	Print help

Command: media import

Imports a media asset, expecting a folder with the same format the export command uses

Usage:

pmv-cli media import [OPTIONS] <PATH>

Arguments:

Argument	Description
`<PATH>`	Path to the folder to import

Options:

Option	Description
`-a, --album <ALBUM>`	Album to upload the media asset into
`-h, --help`	Print help

Command: media set-title

Changes the title of a media asset

Usage:

pmv-cli media set-title <MEDIA> <TITLE>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<TITLE>`	Title

Options:

Option	Description
`-h, --help`	Print help

Command: media set-description

Changes the description of a media asset

Usage:

pmv-cli media set-description <MEDIA> <DESCRIPTION>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<DESCRIPTION>`	Description

Options:

Option	Description
`-h, --help`	Print help

Command: media set-extended-description

Changes the extended description of a media asset

Usage:

pmv-cli media set-extended-description <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the text file containing the extended description

Options:

Option	Description
`-h, --help`	Print help

Command: media set-force-start-beginning

Changes the forced start from beginning parameter of a media asset

Usage:

pmv-cli media set-force-start-beginning <MEDIA> <FORCE_START_BEGINNING>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<FORCE_START_BEGINNING>`	Set to ’true’ if you want to tell the clients not to store the time, so they always start from the beginning

Options:

Option	Description
`-h, --help`	Print help

Command: media set-is-animation

Changes the is-animation parameter of a media asset

Usage:

pmv-cli media set-is-animation <MEDIA> <IS_ANIMATION>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<IS_ANIMATION>`	Set to ’true’ if you want to tell the clients to treat the media as an animation, so they force the loop and disable time skipping

Options:

Option	Description
`-h, --help`	Print help

Command: media set-thumbnail

Sets the thumbnail of a media asset

Usage:

pmv-cli media set-thumbnail <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the thumbnail file

Options:

Option	Description
`-h, --help`	Print help

Command: media get-time-slices

Prints the time slices of a media asset

Usage:

pmv-cli media get-time-slices <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: media set-time-slices

Sets the time slices of a media asset

Usage:

pmv-cli media set-time-slices <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the file containing the time slices

Options:

Option	Description
`-h, --help`	Print help

Command: media set-image-notes

Sets the image notes of a media asset

Usage:

pmv-cli media set-image-notes <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the image notes file

Options:

Option	Description
`-h, --help`	Print help

Command: media add-resolution

Adds new resolution to the media asset

Usage:

pmv-cli media add-resolution <MEDIA> <RESOLUTION>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<RESOLUTION>`	Resolution. Example: 1280x720:30

Options:

Option	Description
`-h, --help`	Print help

Command: media remove-resolution

Removes a resolution from the media asset

Usage:

pmv-cli media remove-resolution <MEDIA> <RESOLUTION>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<RESOLUTION>`	Resolution. Example: 1280x720:30

Options:

Option	Description
`-h, --help`	Print help

Command: media add-subtitle

Adds subtitle file to a media asset

Usage:

pmv-cli media add-subtitle [OPTIONS] <MEDIA> <SUB_ID> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<SUB_ID>`	Subtitle file identifier. Example: EN
`<PATH>`	Path to the subtitles file

Options:

Option	Description
`--name <NAME>`	Subtitle file display name. If not specified, the identifier is used
`-h, --help`	Print help

Command: media rename-subtitle

Renames a subtitles file

Usage:

pmv-cli media rename-subtitle [OPTIONS] <MEDIA> <SUB_ID>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<SUB_ID>`	Subtitle file identifier. Example: EN

Options:

Option	Description
`--new-id <NEW_ID>`	New ID for the subtitles file
`--new-name <NEW_NAME>`	New name for the subtitles file
`-h, --help`	Print help

Command: media remove-subtitle

Removes subtitle file from a media asset

Usage:

pmv-cli media remove-subtitle <MEDIA> <SUB_ID>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<SUB_ID>`	Subtitle file identifier. Example: EN

Options:

Option	Description
`-h, --help`	Print help

Command: media add-audio

Adds audio track file to a media asset

Usage:

pmv-cli media add-audio [OPTIONS] <MEDIA> <TRACK_ID> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<TRACK_ID>`	Audio track file identifier. Example: EN
`<PATH>`	Path to the audio track file

Options:

Option	Description
`--name <NAME>`	Audio track file display name. If not specified, the identifier is used
`-h, --help`	Print help

Command: media rename-audio

Renames an audio track file

Usage:

pmv-cli media rename-audio [OPTIONS] <MEDIA> <TRACK_ID>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<TRACK_ID>`	Audio track file identifier. Example: EN

Options:

Option	Description
`--new-id <NEW_ID>`	New ID for the audio track file
`--new-name <NEW_NAME>`	New name for the audio track file
`-h, --help`	Print help

Command: media remove-audio

Removes audio track file from a media asset

Usage:

pmv-cli media remove-audio <MEDIA> <TRACK_ID>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<TRACK_ID>`	Audio track file identifier. Example: EN

Options:

Option	Description
`-h, --help`	Print help

Command: media add-attachment

Adds attachment file

Usage:

pmv-cli media add-attachment <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the attachment file

Options:

Option	Description
`-h, --help`	Print help

Command: media rename-attachment

Renames attachment file

Usage:

pmv-cli media rename-attachment <MEDIA> <ATTACHMENT_ID> <NAME>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<ATTACHMENT_ID>`	Attachment ID
`<NAME>`	New name for the attachment file

Options:

Option	Description
`-h, --help`	Print help

Command: media remove-attachment

Removes attachment file

Usage:

pmv-cli media remove-attachment <MEDIA> <ATTACHMENT_ID>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<ATTACHMENT_ID>`	Attachment ID

Options:

Option	Description
`-h, --help`	Print help

Command: media re-encode

Re-Encodes a media asset

Usage:

pmv-cli media re-encode <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: media replace

Replaces the media asset with another file

Usage:

pmv-cli media replace <MEDIA> <PATH>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID
`<PATH>`	Path to the media file to upload

Options:

Option	Description
`-h, --help`	Print help

Command: media delete

Deletes a media asset

Usage:

pmv-cli media delete <MEDIA>

Arguments:

Argument	Description
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: random

Retrieves random media assets from the vault

Usage:

pmv-cli random [OPTIONS]

Options:

Option	Description
`-s, --seed <SEED>`	PRNG seed
`-p, --page-size <PAGE_SIZE>`	Page size, 10 by default
`-t, --tag <TAG>`	Filter by a tag
`-e, --extended`	Extended version of the results table
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: search

Searches for media assets in the vault (Basic)

Usage:

pmv-cli search [OPTIONS]

Options:

Option	Description
`-p, --page <PAGE>`	Selects the results page. The fist page is the page 1
`-s, --page-size <PAGE_SIZE>`	Page size, 10 by default
`-t, --tag <TAG>`	Filter by a tag
`-r, --reverse`	Reverses results sorting. By default newest results are first. With this option, oldest results are first
`-e, --extended`	Extended version of the results table
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: advanced-search

Searches for media assets in the vault (Advanced)

Usage:

pmv-cli advanced-search [OPTIONS]

Options:

Option	Description
`-q, --title <TITLE>`	Filter by title
`-d, --description <DESCRIPTION>`	Filter by description
`-k, --media-type <MEDIA_TYPE>`	Filter by media type. Can be: video, audio or image
`-t, --tags <TAGS>`	Filter by tags. Expected a list of tag names, separated by spaces
`-m, --tags-mode <TAGS_MODE>`	Tag filtering mode. Can be: all, any, none or untagged
`-a, --album <ALBUM>`	Filter by album. Expected an album ID, like: #1
`-l, --limit <LIMIT>`	Limit on the number of results to get. 25 by default
`-s, --start-from <START_FROM>`	Media id to use as a stating point for the scanning process
`-r, --reverse`	Reverses results sorting. By default newest results are first. With this option, oldest results are first
`-e, --extended`	Extended version of the results table
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: tag

Manages tags

Usage:

pmv-cli tag <COMMAND>

Commands:

Command	Description
list	List tags
add	Adds a tag to a media asset
remove	Removes a tag from a media asset

Options:

Option	Description
`-h, --help`	Print help

List tags

Usage:

pmv-cli tag list [OPTIONS]

Options:

Option	Description
`-c, --csv`	CSV format
`-a, --alphabetically`	Sort alphabetically by name
`-h, --help`	Print help

Command: tag add

Adds a tag to a media asset

Usage:

pmv-cli tag add <TAG> <MEDIA>

Arguments:

Argument	Description
`<TAG>`	Tag name or identifier
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: tag remove

Removes a tag from a media asset

Usage:

pmv-cli tag remove <TAG> <MEDIA>

Arguments:

Argument	Description
`<TAG>`	Tag name or identifier
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: album

Manages albums

Usage:

pmv-cli album <COMMAND>

Commands:

Command	Description
list	List albums
get	Get album and prints it
create	Creates a new album
rename	Renames an album
delete	Deletes album
add	Adds a media asset to an album
remove	Removes a media asset from an album
set-position	Changes the position of a media asset inside al album

Options:

Option	Description
`-h, --help`	Print help

Command: album list

List albums

Usage:

pmv-cli album list [OPTIONS]

Options:

Option	Description
`-m, --media <MEDIA>`	Filter by media
`-c, --csv`	CSV format
`-a, --alphabetically`	Sort alphabetically by name
`-i, --id-sorted`	Sort by ID
`-h, --help`	Print help

Command: album get

Get album and prints it

Usage:

pmv-cli album get [OPTIONS] <ALBUM>

Arguments:

Argument	Description
`<ALBUM>`	Album ID

Options:

Option	Description
`-e, --extended`	Extended version of the results table
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: album create

Creates a new album

Usage:

pmv-cli album create <NAME>

Arguments:

Argument	Description
`<NAME>`	Album name

Options:

Option	Description
`-h, --help`	Print help

Command: album rename

Renames an album

Usage:

pmv-cli album rename <ALBUM> <NAME>

Arguments:

Argument	Description
`<ALBUM>`	Album ID
`<NAME>`	Album name

Options:

Option	Description
`-h, --help`	Print help

Command: album delete

Deletes album

Usage:

pmv-cli album delete <ALBUM>

Arguments:

Argument	Description
`<ALBUM>`	Album ID

Options:

Option	Description
`-h, --help`	Print help

Command: album add

Adds a media asset to an album

Usage:

pmv-cli album add <ALBUM> <MEDIA>

Arguments:

Argument	Description
`<ALBUM>`	Album ID
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: album remove

Removes a media asset from an album

Usage:

pmv-cli album remove <ALBUM> <MEDIA>

Arguments:

Argument	Description
`<ALBUM>`	Album ID
`<MEDIA>`	Media asset ID

Options:

Option	Description
`-h, --help`	Print help

Command: album set-position

Changes the position of a media asset inside al album

Usage:

pmv-cli album set-position <ALBUM> <MEDIA> <POSITION>

Arguments:

Argument	Description
`<ALBUM>`	Album ID
`<MEDIA>`	Media asset ID
`<POSITION>`	New position for the media asset, starting at 1

Options:

Option	Description
`-h, --help`	Print help

Command: config

Manages vault configuration

Usage:

pmv-cli config <COMMAND>

Commands:

Command	Description
get	Gets vault configuration
get-css	Gets custom CSS code configured for the vault
set-title	Sets vault title
set-max-tasks	Sets max tasks in parallel
set-encoding-threads	Sets number of encoding threads to use
set-video-previews-interval	Sets the video previews interval in seconds
set-css	Sets custom CSS for the vault
clear-css	Clears custom CSS for the vault
add-video-resolution	Adds video resolution
remove-video-resolution	Removes video resolution
add-image-resolution	Adds image resolution
remove-image-resolution	Removes image resolution

Options:

Option	Description
`-h, --help`	Print help

Command: config get

Gets vault configuration

Usage:

pmv-cli config get

Options:

Option	Description
`-h, --help`	Print help

Command: config get-css

Gets custom CSS code configured for the vault

Usage:

pmv-cli config get-css

Options:

Option	Description
`-h, --help`	Print help

Command: config set-title

Sets vault title

Usage:

pmv-cli config set-title <TITLE>

Arguments:

Argument	Description
`<TITLE>`	Vault title

Options:

Option	Description
`-h, --help`	Print help

Command: config set-max-tasks

Sets max tasks in parallel

Usage:

pmv-cli config set-max-tasks <MAX_TASKS>

Arguments:

Argument	Description
`<MAX_TASKS>`	Max tasks in parallel

Options:

Option	Description
`-h, --help`	Print help

Command: config set-encoding-threads

Sets number of encoding threads to use

Usage:

pmv-cli config set-encoding-threads <ENCODING_THREADS>

Arguments:

Argument	Description
`<ENCODING_THREADS>`	Number of encoding threads to use

Options:

Option	Description
`-h, --help`	Print help

Command: config set-video-previews-interval

Sets the video previews interval in seconds

Usage:

pmv-cli config set-video-previews-interval <INTERVAL_SECONDS>

Arguments:

Argument	Description
`<INTERVAL_SECONDS>`	Interval in seconds

Options:

Option	Description
`-h, --help`	Print help

Command: config set-css

Sets custom CSS for the vault

Usage:

pmv-cli config set-css <FILE_PATH>

Arguments:

Argument	Description
`<FILE_PATH>`	Path to the css file to use

Options:

Option	Description
`-h, --help`	Print help

Command: config clear-css

Clears custom CSS for the vault

Usage:

pmv-cli config clear-css

Options:

Option	Description
`-h, --help`	Print help

Command: config add-video-resolution

Adds video resolution

Usage:

pmv-cli config add-video-resolution <RESOLUTION>

Arguments:

Argument	Description
`<RESOLUTION>`	Video resolution. Example: 1280x720:30

Options:

Option	Description
`-h, --help`	Print help

Command: config remove-video-resolution

Removes video resolution

Usage:

pmv-cli config remove-video-resolution <RESOLUTION>

Arguments:

Argument	Description
`<RESOLUTION>`	Video resolution. Example: 1280x720:30

Options:

Option	Description
`-h, --help`	Print help

Command: config add-image-resolution

Adds image resolution

Usage:

pmv-cli config add-image-resolution <RESOLUTION>

Arguments:

Argument	Description
`<RESOLUTION>`	Image resolution. Example: 1280x720

Options:

Option	Description
`-h, --help`	Print help

Command: config remove-image-resolution

Removes image resolution

Usage:

pmv-cli config remove-image-resolution <RESOLUTION>

Arguments:

Argument	Description
`<RESOLUTION>`	Image resolution. Example: 1280x720

Options:

Option	Description
`-h, --help`	Print help

Command: task

Retrieves tasks information

Usage:

pmv-cli task <COMMAND>

Commands:

Command	Description
list	Lists current existing tasks
monitor	Monitors tasks
get	Get task status
wait	Waits for a task to finish, monitoring its status

Options:

Option	Description
`-h, --help`	Print help

Command: task list

Lists current existing tasks

Usage:

pmv-cli task list [OPTIONS]

Options:

Option	Description
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: task monitor

Monitors tasks

Usage:

pmv-cli task monitor

Options:

Option	Description
`-h, --help`	Print help

Command: task get

Get task status

Usage:

pmv-cli task get <TASK>

Arguments:

Argument	Description
`<TASK>`	Task identifier

Options:

Option	Description
`-h, --help`	Print help

Command: task wait

Waits for a task to finish, monitoring its status

Usage:

pmv-cli task wait <TASK>

Arguments:

Argument	Description
`<TASK>`	Task identifier

Options:

Option	Description
`-h, --help`	Print help

Command: invites

Manages invites

Usage:

pmv-cli invites <COMMAND>

Commands:

Command	Description
check	Prints the current invite code, if any
generate	Generates a new invite code
clear	Clears the current invite code
list-sessions	List active invited sessions
close-session	Closes an invited session

Options:

Option	Description
`-h, --help`	Print help

Command: invites check

Prints the current invite code, if any

Usage:

pmv-cli invites check

Options:

Option	Description
`-h, --help`	Print help

Command: invites generate

Generates a new invite code

Usage:

pmv-cli invites generate [OPTIONS]

Options:

Option	Description
`-D, --duration <DURATION>`	Session duration. Can be: day, week, month or year
`-h, --help`	Print help

Command: invites clear

Clears the current invite code

Usage:

pmv-cli invites clear

Options:

Option	Description
`-h, --help`	Print help

Command: invites list-sessions

List active invited sessions

Usage:

pmv-cli invites list-sessions [OPTIONS]

Options:

Option	Description
`-c, --csv`	CSV format
`-h, --help`	Print help

Command: invites close-session

Closes an invited session

Usage:

pmv-cli invites close-session <INDEX>

Arguments:

Argument	Description
`<INDEX>`	Session index

Options:

Option	Description
`-h, --help`	Print help

Command: batch

Applies a batch operation to a list of media assets

Usage:

pmv-cli batch [OPTIONS] <COMMAND>

Commands:

Command	Description
add-tags	Adds tags to the media assets
remove-tags	Removes tags from the media assets
add-to-album	Adds media assets into an album
remove-from-album	Removes media assets from an album, if they were in it
delete	Delete media assets

Options:

Option	Description
`-q, --title <TITLE>`	Filter by title
`-d, --description <DESCRIPTION>`	Filter by description
`-k, --media-type <MEDIA_TYPE>`	Filter by media type. Can be: video, audio or image
`-t, --tags <TAGS>`	Filter by tags. Expected a list of tag names, separated by spaces
`-m, --tags-mode <TAGS_MODE>`	Tag filtering mode. Can be: all, any, none or untagged
`-a, --album <ALBUM>`	Filter by album. Expected an album ID, like: #1
`-e, --everything`	Do not filter. Apply to the entire vault instead
`-h, --help`	Print help

Command: batch add-tags

Adds tags to the media assets

Usage:

pmv-cli batch add-tags <TAGS>

Arguments:

Argument	Description
`<TAGS>`	List of tag names, separated by spaces

Options:

Option	Description
`-h, --help`	Print help

Command: batch remove-tags

Removes tags from the media assets

Usage:

pmv-cli batch remove-tags <TAGS>

Arguments:

Argument	Description
`<TAGS>`	List of tag names, separated by spaces

Options:

Option	Description
`-h, --help`	Print help

Command: batch add-to-album

Adds media assets into an album

Usage:

pmv-cli batch add-to-album <ALBUM>

Arguments:

Argument	Description
`<ALBUM>`	Album ID

Options:

Option	Description
`-h, --help`	Print help

Command: batch remove-from-album

Removes media assets from an album, if they were in it

Usage:

pmv-cli batch remove-from-album <ALBUM>

Arguments:

Argument	Description
`<ALBUM>`	Album ID

Options:

Option	Description
`-h, --help`	Print help

Command: batch delete

Delete media assets

Usage:

pmv-cli batch delete

Options:

Option	Description
`-h, --help`	Print help

Command: get-server-information

Gets server information, like the version it is using

Usage:

pmv-cli get-server-information

Options:

Option	Description
`-h, --help`	Print help

Console Client

Download

Usage

1 - Manual

Command: login

Command: logout

Command: account

Command: account context

Command: account change-username

Command: account change-password

Command: account list

Command: account create

Command: account delete

Command: media

Command: media get

Command: media stats

Command: media download

Command: media export

Command: media upload

Command: media import

Command: media set-title

Command: media set-description

Command: media set-extended-description

Command: media set-force-start-beginning

Command: media set-is-animation

Command: media set-thumbnail

Command: media get-time-slices

Command: media set-time-slices

Command: media set-image-notes

Command: media add-resolution

Command: media remove-resolution

Command: media add-subtitle

Command: media rename-subtitle

Command: media remove-subtitle

Command: media add-audio

Command: media rename-audio

Command: media remove-audio

Command: media add-attachment

Command: media rename-attachment

Command: media remove-attachment

Command: media re-encode

Command: media replace

Command: media delete

Command: random

Command: search

Command: advanced-search

Command: tag

Command: tag list

Command: tag add

Command: tag remove

Command: album

Command: album list

Command: album get

Command: album create

Command: album rename

Command: album delete

Command: album add

Command: album remove

Command: album set-position

Command: config

Command: config get

Command: config get-css

Command: config set-title

Command: config set-max-tasks

Command: config set-encoding-threads

Command: config set-video-previews-interval

Command: config set-css

Command: config clear-css

Command: config add-video-resolution

Command: config remove-video-resolution

Command: config add-image-resolution

Command: config remove-image-resolution

Command: task

Command: task list

Command: task monitor

Command: task get

Command: task wait

Command: invites

Command: invites check

Command: invites generate