Skip to content

CLI Reference¤

This page provides documentation for our command line tools.

app¤

Entry point for the TVSD CLI application.

This function initializes the config file before setting instance level. It applies the config and sets the state of the application based on the provided options.

Usage:

tvsd [OPTIONS] COMMAND [ARGS]...

Options:

  -v, --version             Show the application's version and exit.
  --verbose / --no-verbose  Show verbose output.  [default: no-verbose]
  -sd, --series-dir TEXT    Specify the series directory, overrides config
                            file
  -mr, --media-root TEXT    Specify the media root, overrides config file
  -e, --env TEXT            Specify the environment
  --dry-run
  --install-completion      Install completion for the current shell.
  --show-completion         Show completion for the current shell, to copy it
                            or customize the installation.

clean-base¤

Remove empty directories in the base path

Usage:

tvsd clean-base [OPTIONS]

Options:

  -i, --interactive  Interactive mode
  -g, --greedy       Remove directories without videos
  --target TEXT      Target directory
  --no-confirm

clean-temp¤

Cleans the temp directory.

This function validates the config file and then prompts the user to confirm whether they want to delete all files in the temp directory. If the user confirms, all files in the temp directory are deleted and a new empty directory is created.

Raises: FileNotFoundError: If temp directory does not exist

Usage:

tvsd clean-temp [OPTIONS]

list-shows¤

List all shows in the database.

This function retrieves a list of all shows in the database and displays them in a table format.

Usage:

tvsd list-shows [OPTIONS]

Print the current state of the application.

This function prints the current state of the application, including all key-value pairs in the state dictionary.

Raises: ConfigFileError: If the configuration file is invalid or missing.

Usage:

tvsd print-state [OPTIONS]

remove-show¤

List shows and remove selected show.

This function lists all the shows and their indices, prompts the user to select a show index to remove, and then removes the selected show. If the user selects an invalid index or cancels the prompt, the function aborts and raises a typer.Abort() exception.

Returns: None

Usage:

tvsd remove-show [OPTIONS]

Search for media and download

Args: specials_only (Optional[bool], optional): Download only specials episode query (str): query string

Usage:

tvsd search [OPTIONS] QUERY

Options:

  QUERY           [required]
  -s, --specials  Download Specials Only