Skip to content

Latest commit

 

History

History
291 lines (176 loc) · 5.42 KB

docs.md

File metadata and controls

291 lines (176 loc) · 5.42 KB

unitunes

Unitunes playlist manager. https://github.com/platers/unitunes

Usage:

$ unitunes [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • add: Add a playlist to the config file.
  • fetch: Quickly add playlists from a service.
  • init: Create a new playlist manager.
  • list: List all playlists.
  • pull: Pull playlist tracks from services.
  • push: Push playlist tracks to services.
  • search: Search for tracks on a service.
  • service: Manage services.
  • view: Show a playlists metadata and tracks.

unitunes add

Add a playlist to the config file.

If a playlist with the same name already exists, the url will be added to the playlist. Otherwise, a new playlist will be created.

Usage:

$ unitunes add [OPTIONS] PLAYLIST_NAME SERVICE_NAME [URL]

Arguments:

  • PLAYLIST_NAME: [required]
  • SERVICE_NAME: [required]
  • [URL]

Options:

  • --help: Show this message and exit.

unitunes fetch

Quickly add playlists from a service.

Asks for confirmation before adding each playlist unless the force flag is set.

Usage:

$ unitunes fetch [OPTIONS] [SERVICE_NAME]

Arguments:

  • [SERVICE_NAME]: Service to fetch from.

Options:

  • -f, --force: Auto accept prompts. [default: False]
  • --help: Show this message and exit.

unitunes init

Create a new playlist manager.

Creates a new playlist manager in the given directory.

Usage:

$ unitunes init [OPTIONS] [DIRECTORY]

Arguments:

  • [DIRECTORY]: Directory to store playlist files in. [default: .]

Options:

  • --help: Show this message and exit.

unitunes list

List all playlists.

Usage:

$ unitunes list [OPTIONS]

Options:

  • --plain / --no-plain: [default: False]
  • --help: Show this message and exit.

unitunes pull

Pull playlist tracks from services.

If no playlist is specified, all playlists are pulled. If no service is specified, all services are used.

Usage:

$ unitunes pull [OPTIONS] [PLAYLIST_NAMES]...

Arguments:

  • [PLAYLIST_NAMES]...: Playlists to pull from services. If not specified, all playlists are pulled.

Options:

  • -s, --service TEXT: Services to pull from. If not specified, all services are used.
  • -v, --verbose: [default: False]
  • --help: Show this message and exit.

unitunes push

Push playlist tracks to services.

Asks for confirmation before pushing.

If no playlist is specified, all playlists are pushed. If no service is specified, all services are used.

Usage:

$ unitunes push [OPTIONS] [PLAYLIST_NAMES]...

Arguments:

  • [PLAYLIST_NAMES]...: Playlists to push to services. If not specified, all playlists are pushed.

Options:

  • -s, --service TEXT: Services to push to. If not specified, all services are used.
  • --help: Show this message and exit.

unitunes search

Search for tracks on a service. Adds found URI's to tracks.

If the preview flag is set, URI's will not be added.

Usage:

$ unitunes search [OPTIONS] SERVICE:[spotify|ytm|mb] PLAYLIST_NAME

Arguments:

  • SERVICE:[spotify|ytm|mb]: [required]
  • PLAYLIST_NAME: [required]

Options:

  • -p, --preview: Preview tracks to add without adding them. [default: False]
  • -d, --debug: Show debug information [default: False]
  • --onlyfailed: Only show failed tracks in debug information. [default: False]
  • --showall: Show all tracks in debug information. [default: False]
  • --help: Show this message and exit.

unitunes service

Manage services.

Usage:

$ unitunes service [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Add a service.
  • list: List all services.
  • playlists: List all user playlists on a service.
  • remove: Remove a service.

unitunes service add

Add a service.

If no namm is provided, the service type will be used as the name.

Usage:

$ unitunes service add [OPTIONS] [SERVICE_TYPE]:[spotify|ytm|mb] [SERVICE_CONFIG_PATH] [SERVICE_NAME]

Arguments:

  • [SERVICE_TYPE]:[spotify|ytm|mb]: Service to add.
  • [SERVICE_CONFIG_PATH]: Path to service config.
  • [SERVICE_NAME]: Name of service. Defaults to service type.

Options:

  • --help: Show this message and exit.

unitunes service list

List all services.

Usage:

$ unitunes service list [OPTIONS]

Options:

  • --plain / --no-plain: [default: False]
  • --help: Show this message and exit.

unitunes service playlists

List all user playlists on a service.

Usage:

$ unitunes service playlists [OPTIONS] SERVICE_NAME

Arguments:

  • SERVICE_NAME: [required]

Options:

  • --help: Show this message and exit.

unitunes service remove

Remove a service.

Usage:

$ unitunes service remove [OPTIONS] SERVICE_NAME

Arguments:

  • SERVICE_NAME: [required]

Options:

  • -f, --force: [default: False]
  • --help: Show this message and exit.

unitunes view

Show a playlists metadata and tracks.

Usage:

$ unitunes view [OPTIONS] PLAYLIST

Arguments:

  • PLAYLIST: [required]

Options:

  • --help: Show this message and exit.